{ "name": "aws", "displayName": "AWS", "description": "A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.", "keywords": [ "pulumi", "aws" ], "homepage": "https://pulumi.io", "license": "Apache-2.0", "attribution": "This Pulumi package is based on the [`aws` Terraform Provider](https://github.com/hashicorp/terraform-provider-aws).", "repository": "https://github.com/pulumi/pulumi-aws", "meta": { "moduleFormat": "(.*)(?:/[^/]*)" }, "language": { "csharp": { "packageReferences": { "Pulumi": "3.*" }, "namespaces": { "accessanalyzer": "AccessAnalyzer", "account": "Account", "acm": "Acm", "acmpca": "Acmpca", "alb": "Alb", "amp": "Amp", "amplify": "Amplify", "apigateway": "ApiGateway", "apigatewayv2": "ApiGatewayV2", "appautoscaling": "AppAutoScaling", "appconfig": "AppConfig", "appfabric": "AppFabric", "appflow": "AppFlow", "appintegrations": "AppIntegrations", "applicationinsights": "ApplicationInsights", "applicationloadbalancing": "ApplicationLoadBalancing", "appmesh": "AppMesh", "apprunner": "AppRunner", "appstream": "AppStream", "appsync": "AppSync", "athena": "Athena", "auditmanager": "Auditmanager", "autoscaling": "AutoScaling", "autoscalingplans": "AutoScalingPlans", "aws": "Aws", "backup": "Backup", "batch": "Batch", "bcmdata": "BcmData", "bedrock": "Bedrock", "bedrockfoundation": "BedrockFoundation", "bedrockmodel": "BedrockModel", "budgets": "Budgets", "cfg": "Cfg", "chatbot": "Chatbot", "chime": "Chime", "chimesdkmediapipelines": "ChimeSDKMediaPipelines", "cleanrooms": "CleanRooms", "cloud9": "Cloud9", "cloudcontrol": "CloudControl", "cloudformation": "CloudFormation", "cloudfront": "CloudFront", "cloudhsmv2": "CloudHsmV2", "cloudsearch": "CloudSearch", "cloudtrail": "CloudTrail", "cloudwatch": "CloudWatch", "codeartifact": "CodeArtifact", "codebuild": "CodeBuild", "codecatalyst": "CodeCatalyst", "codecommit": "CodeCommit", "codeconnections": "CodeConnections", "codedeploy": "CodeDeploy", "codeguruprofiler": "CodeGuruProfiler", "codegurureviewer": "CodeGuruReviewer", "codepipeline": "CodePipeline", "codestarconnections": "CodeStarConnections", "codestarnotifications": "CodeStarNotifications", "cognito": "Cognito", "comprehend": "Comprehend", "computeoptimizer": "ComputeOptimizer", "connect": "Connect", "controltower": "ControlTower", "costexplorer": "CostExplorer", "costoptimizationhub": "CostOptimizationHub", "cur": "Cur", "customerprofiles": "CustomerProfiles", "dataexchange": "DataExchange", "datapipeline": "DataPipeline", "datasync": "DataSync", "datazone": "DataZone", "dax": "Dax", "detective": "Detective", "devicefarm": "DeviceFarm", "devopsguru": "DevOpsGuru", "directconnect": "DirectConnect", "directoryservice": "DirectoryService", "dlm": "Dlm", "dms": "Dms", "docdb": "DocDB", "drs": "Drs", "dynamodb": "DynamoDB", "ebs": "Ebs", "ec2": "Ec2", "ec2clientvpn": "Ec2ClientVpn", "ec2transitgateway": "Ec2TransitGateway", "ecr": "Ecr", "ecrpublic": "EcrPublic", "ecs": "Ecs", "efs": "Efs", "eks": "Eks", "elasticache": "ElastiCache", "elasticbeanstalk": "ElasticBeanstalk", "elasticloadbalancing": "ElasticLoadBalancing", "elasticloadbalancingv2": "ElasticLoadBalancingV2", "elasticsearch": "ElasticSearch", "elastictranscoder": "ElasticTranscoder", "elb": "Elb", "emr": "Emr", "emrcontainers": "EmrContainers", "emrserverless": "EmrServerless", "evidently": "Evidently", "finspace": "FinSpace", "fis": "Fis", "fms": "Fms", "fsx": "Fsx", "gamelift": "GameLift", "glacier": "Glacier", "globalaccelerator": "GlobalAccelerator", "glue": "Glue", "grafana": "Grafana", "guardduty": "GuardDuty", "iam": "Iam", "identitystore": "IdentityStore", "imagebuilder": "ImageBuilder", "index": "index", "inspector": "Inspector", "inspector2": "Inspector2", "iot": "Iot", "ivs": "Ivs", "ivschat": "IvsChat", "kendra": "Kendra", "keyspaces": "Keyspaces", "kinesis": "Kinesis", "kinesisanalyticsv2": "KinesisAnalyticsV2", "kms": "Kms", "lakeformation": "LakeFormation", "lambda": "Lambda", "lb": "LB", "lex": "Lex", "licensemanager": "LicenseManager", "lightsail": "LightSail", "location": "Location", "m2": "M2", "macie": "Macie", "macie2": "Macie2", "mediaconvert": "MediaConvert", "medialive": "MediaLive", "mediapackage": "MediaPackage", "mediapackagev2": "MediaPackageV2", "mediastore": "MediaStore", "memorydb": "MemoryDb", "mq": "Mq", "msk": "Msk", "mskconnect": "MskConnect", "mwaa": "Mwaa", "neptune": "Neptune", "neptunegraph": "NeptuneGraph", "networkfirewall": "NetworkFirewall", "networkmanager": "NetworkManager", "networkmonitor": "NetworkMonitor", "oam": "Oam", "opensearch": "OpenSearch", "opensearchingest": "OpenSearchIngest", "opsworks": "OpsWorks", "organizations": "Organizations", "outposts": "Outposts", "paymentcryptography": "PaymentCryptography", "pinpoint": "Pinpoint", "pipes": "Pipes", "polly": "Polly", "pricing": "Pricing", "qbusiness": "Qbusiness", "qldb": "Qldb", "quicksight": "Quicksight", "ram": "Ram", "rbin": "Rbin", "rds": "Rds", "redshift": "RedShift", "redshiftdata": "RedshiftData", "redshiftserverless": "RedshiftServerless", "rekognition": "Rekognition", "resiliencehub": "ResilienceHub", "resourceexplorer": "ResourceExplorer", "resourcegroups": "ResourceGroups", "resourcegroupstaggingapi": "ResourceGroupsTaggingApi", "rolesanywhere": "RolesAnywhere", "route53": "Route53", "route53domains": "Route53Domains", "route53recoverycontrol": "Route53RecoveryControl", "route53recoveryreadiness": "Route53RecoveryReadiness", "rum": "Rum", "s3": "S3", "s3control": "S3Control", "s3outposts": "S3Outposts", "s3tables": "S3Tables", "sagemaker": "Sagemaker", "scheduler": "Scheduler", "schemas": "Schemas", "secretsmanager": "SecretsManager", "securityhub": "SecurityHub", "securitylake": "SecurityLake", "serverlessrepository": "ServerlessRepository", "servicecatalog": "ServiceCatalog", "servicediscovery": "ServiceDiscovery", "servicequotas": "ServiceQuotas", "ses": "Ses", "sesv2": "SesV2", "sfn": "Sfn", "shield": "Shield", "signer": "Signer", "simpledb": "SimpleDB", "sns": "Sns", "sqs": "Sqs", "ssm": "Ssm", "ssmcontacts": "SsmContacts", "ssmincidents": "SsmIncidents", "ssoadmin": "SsoAdmin", "storagegateway": "StorageGateway", "swf": "Swf", "synthetics": "Synthetics", "timestreaminfluxdb": "TimestreamInfluxDB", "timestreamquery": "TimestreamQuery", "timestreamwrite": "TimestreamWrite", "transcribe": "Transcribe", "transfer": "Transfer", "verifiedaccess": "VerifiedAccess", "verifiedpermissions": "VerifiedPermissions", "vpc": "Vpc", "vpclattice": "VpcLattice", "waf": "Waf", "wafregional": "WafRegional", "wafv2": "WafV2", "worklink": "WorkLink", "workspaces": "Workspaces", "xray": "Xray" }, "compatibility": "tfbridge20", "respectSchemaVersion": true }, "go": { "importBasePath": "github.com/pulumi/pulumi-aws/sdk/v6/go/aws", "generateResourceContainerTypes": true, "generateExtraInputTypes": true, "respectSchemaVersion": true }, "nodejs": { "packageDescription": "A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.", "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/hashicorp/terraform-provider-aws)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-aws` repo](https://github.com/hashicorp/terraform-provider-aws/issues).", "dependencies": { "mime": "^2.0.0" }, "devDependencies": { "@types/mime": "^2.0.0", "@types/node": "^10.0.0" }, "compatibility": "tfbridge20", "disableUnionOutputTypes": true, "respectSchemaVersion": true }, "python": { "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/hashicorp/terraform-provider-aws)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-aws` repo](https://github.com/hashicorp/terraform-provider-aws/issues).", "compatibility": "tfbridge20", "respectSchemaVersion": true, "pyproject": { "enabled": true }, "inputTypes": "classes-and-dicts" } }, "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.\n", "secret": true }, "allowedAccountIds": { "type": "array", "items": { "type": "string" } }, "assumeRole": { "$ref": "#/types/aws:config/assumeRole:assumeRole" }, "assumeRoleWithWebIdentity": { "$ref": "#/types/aws:config/assumeRoleWithWebIdentity:assumeRoleWithWebIdentity" }, "customCaBundle": { "type": "string", "description": "File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment\nvariable. (Setting `ca_bundle` in the shared config file is not supported.)\n" }, "defaultTags": { "$ref": "#/types/aws:config/defaultTags:defaultTags", "description": "Configuration block with settings to default resource tags across all resources.\n" }, "ec2MetadataServiceEndpoint": { "type": "string", "description": "Address of the EC2 metadata service endpoint to use. Can also be configured using the\n`AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable.\n" }, "ec2MetadataServiceEndpointMode": { "type": "string", "description": "Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the\n`AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/aws:config/endpoints:endpoints" } }, "forbiddenAccountIds": { "type": "array", "items": { "type": "string" } }, "httpProxy": { "type": "string", "description": "URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the `HTTP_PROXY` or\n`http_proxy` environment variables.\n" }, "httpsProxy": { "type": "string", "description": "URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the `HTTPS_PROXY` or\n`https_proxy` environment variables.\n" }, "ignoreTags": { "$ref": "#/types/aws:config/ignoreTags:ignoreTags", "description": "Configuration block with settings to ignore resource tags across all resources.\n" }, "insecure": { "type": "boolean", "description": "Explicitly allow the provider to perform \"insecure\" SSL requests. If omitted, default value is `false`\n" }, "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.\n" }, "noProxy": { "type": "string", "description": "Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the `NO_PROXY` or\n`no_proxy` environment variables.\n" }, "profile": { "type": "string", "description": "The profile for API operations. If not set, the default profile created with `aws configure` will be used.\n" }, "region": { "type": "string", "$ref": "#/types/aws:index/region:Region", "description": "The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.\n", "defaultInfo": { "environment": [ "AWS_REGION", "AWS_DEFAULT_REGION" ] } }, "retryMode": { "type": "string", "description": "Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the\n`AWS_RETRY_MODE` environment variable.\n" }, "s3UsEast1RegionalEndpoint": { "type": "string", "description": "Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid\nvalues are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment\nvariable or the `s3_us_east_1_regional_endpoint` shared config file parameter\n" }, "s3UsePathStyle": { "type": "boolean", "description": "Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY. By\ndefault, the S3 client will use virtual hosted bucket addressing when possible (https://BUCKET.s3.amazonaws.com/KEY).\nSpecific to the Amazon S3 service.\n" }, "secretKey": { "type": "string", "description": "The secret key for API operations. You can retrieve this from the 'Security \u0026 Credentials' section of the AWS console.\n", "secret": true }, "sharedConfigFiles": { "type": "array", "items": { "type": "string" }, "description": "List of paths to shared config files. If not set, defaults to [~/.aws/config].\n" }, "sharedCredentialsFiles": { "type": "array", "items": { "type": "string" }, "description": "List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials].\n" }, "skipCredentialsValidation": { "type": "boolean", "description": "Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS\navailable/implemented.\n", "default": false }, "skipMetadataApiCheck": { "type": "boolean", "description": "Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.\n" }, "skipRegionValidation": { "type": "boolean", "description": "Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are\nnot public (yet).\n", "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.\n" }, "stsRegion": { "type": "string", "description": "The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.\n" }, "token": { "type": "string", "description": "session token. A session token is only required if you are using temporary security credentials.\n", "secret": true }, "tokenBucketRateLimiterCapacity": { "type": "integer", "description": "The capacity of the AWS SDK's token bucket rate limiter.\n" }, "useDualstackEndpoint": { "type": "boolean", "description": "Resolve an endpoint with DualStack capability\n" }, "useFipsEndpoint": { "type": "boolean", "description": "Resolve an endpoint with FIPS capability\n" } } }, "types": { "aws:accessanalyzer/AnalyzerConfiguration:AnalyzerConfiguration": { "properties": { "unusedAccess": { "$ref": "#/types/aws:accessanalyzer/AnalyzerConfigurationUnusedAccess:AnalyzerConfigurationUnusedAccess", "description": "A block that specifies the configuration of an unused access analyzer for an AWS organization or account. Documented below\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:accessanalyzer/AnalyzerConfigurationUnusedAccess:AnalyzerConfigurationUnusedAccess": { "properties": { "unusedAccessAge": { "type": "integer", "description": "The specified access age in days for which to generate findings for unused access.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:accessanalyzer/ArchiveRuleFilter:ArchiveRuleFilter": { "properties": { "contains": { "type": "array", "items": { "type": "string" }, "description": "Contains comparator.\n" }, "criteria": { "type": "string", "description": "Filter criteria.\n" }, "eqs": { "type": "array", "items": { "type": "string" }, "description": "Equals comparator.\n" }, "exists": { "type": "string", "description": "Boolean comparator.\n" }, "neqs": { "type": "array", "items": { "type": "string" }, "description": "Not Equals comparator.\n" } }, "type": "object", "required": [ "criteria" ], "language": { "nodejs": { "requiredOutputs": [ "contains", "criteria", "eqs", "exists", "neqs" ] } } }, "aws:acm/CertificateDomainValidationOption:CertificateDomainValidationOption": { "properties": { "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN) in the certificate.\n" }, "resourceRecordName": { "type": "string", "description": "The name of the DNS record to create to validate the certificate\n" }, "resourceRecordType": { "type": "string", "description": "The type of DNS record to create\n" }, "resourceRecordValue": { "type": "string", "description": "The value the DNS record needs to have\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domainName", "resourceRecordName", "resourceRecordType", "resourceRecordValue" ] } } }, "aws:acm/CertificateOptions:CertificateOptions": { "properties": { "certificateTransparencyLoggingPreference": { "type": "string", "description": "Whether certificate details should be added to a certificate transparency log. Valid values are `ENABLED` or `DISABLED`. See https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency for more details.\n" } }, "type": "object" }, "aws:acm/CertificateRenewalSummary:CertificateRenewalSummary": { "properties": { "renewalStatus": { "type": "string", "description": "The status of ACM's managed renewal of the certificate\n" }, "renewalStatusReason": { "type": "string", "description": "The reason that a renewal request was unsuccessful or is pending\n" }, "updatedAt": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "renewalStatus", "renewalStatusReason", "updatedAt" ] } } }, "aws:acm/CertificateValidationOption:CertificateValidationOption": { "properties": { "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN) in the certificate.\n", "willReplaceOnChanges": true }, "validationDomain": { "type": "string", "description": "Domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the `domain_name` value or a superdomain of the `domain_name` value. For example, if you request a certificate for `\"testing.example.com\"`, you can specify `\"example.com\"` for this value.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "domainName", "validationDomain" ] }, "aws:acmpca/CertificateAuthorityCertificateAuthorityConfiguration:CertificateAuthorityCertificateAuthorityConfiguration": { "properties": { "keyAlgorithm": { "type": "string", "description": "Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate. Valid values can be found in the [ACM PCA Documentation](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthorityConfiguration.html).\n", "willReplaceOnChanges": true }, "signingAlgorithm": { "type": "string", "description": "Name of the algorithm your private CA uses to sign certificate requests. Valid values can be found in the [ACM PCA Documentation](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthorityConfiguration.html).\n", "willReplaceOnChanges": true }, "subject": { "$ref": "#/types/aws:acmpca/CertificateAuthorityCertificateAuthorityConfigurationSubject:CertificateAuthorityCertificateAuthorityConfigurationSubject", "description": "Nested argument that contains X.500 distinguished name information. At least one nested attribute must be specified.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "keyAlgorithm", "signingAlgorithm", "subject" ] }, "aws:acmpca/CertificateAuthorityCertificateAuthorityConfigurationSubject:CertificateAuthorityCertificateAuthorityConfigurationSubject": { "properties": { "commonName": { "type": "string", "description": "Fully qualified domain name (FQDN) associated with the certificate subject. Must be less than or equal to 64 characters in length.\n", "willReplaceOnChanges": true }, "country": { "type": "string", "description": "Two digit code that specifies the country in which the certificate subject located. Must be less than or equal to 2 characters in length.\n", "willReplaceOnChanges": true }, "distinguishedNameQualifier": { "type": "string", "description": "Disambiguating information for the certificate subject. Must be less than or equal to 64 characters in length.\n", "willReplaceOnChanges": true }, "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. Must be less than or equal to 3 characters in length.\n", "willReplaceOnChanges": true }, "givenName": { "type": "string", "description": "First name. Must be less than or equal to 16 characters in length.\n", "willReplaceOnChanges": true }, "initials": { "type": "string", "description": "Concatenation that typically contains the first letter of the `given_name`, the first letter of the middle name if one exists, and the first letter of the `surname`. Must be less than or equal to 5 characters in length.\n", "willReplaceOnChanges": true }, "locality": { "type": "string", "description": "Locality (such as a city or town) in which the certificate subject is located. Must be less than or equal to 128 characters in length.\n", "willReplaceOnChanges": true }, "organization": { "type": "string", "description": "Legal name of the organization with which the certificate subject is affiliated. Must be less than or equal to 64 characters in length.\n", "willReplaceOnChanges": true }, "organizationalUnit": { "type": "string", "description": "Subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. Must be less than or equal to 64 characters in length.\n", "willReplaceOnChanges": true }, "pseudonym": { "type": "string", "description": "Typically a shortened version of a longer `given_name`. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. Must be less than or equal to 128 characters in length.\n", "willReplaceOnChanges": true }, "state": { "type": "string", "description": "State in which the subject of the certificate is located. Must be less than or equal to 128 characters in length.\n", "willReplaceOnChanges": true }, "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. Must be less than or equal to 40 characters in length.\n", "willReplaceOnChanges": true }, "title": { "type": "string", "description": "Title such as Mr. or Ms. which is pre-pended to the name to refer formally to the certificate subject. Must be less than or equal to 64 characters in length.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:acmpca/CertificateAuthorityRevocationConfiguration:CertificateAuthorityRevocationConfiguration": { "properties": { "crlConfiguration": { "$ref": "#/types/aws:acmpca/CertificateAuthorityRevocationConfigurationCrlConfiguration:CertificateAuthorityRevocationConfigurationCrlConfiguration", "description": "Nested argument containing configuration of the certificate revocation list (CRL), if any, maintained by the certificate authority. Defined below.\n" }, "ocspConfiguration": { "$ref": "#/types/aws:acmpca/CertificateAuthorityRevocationConfigurationOcspConfiguration:CertificateAuthorityRevocationConfigurationOcspConfiguration", "description": "Nested argument containing configuration of\nthe custom OCSP responder endpoint. Defined below.\n" } }, "type": "object" }, "aws:acmpca/CertificateAuthorityRevocationConfigurationCrlConfiguration:CertificateAuthorityRevocationConfigurationCrlConfiguration": { "properties": { "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. Must be less than or equal to 253 characters in length.\n" }, "enabled": { "type": "boolean", "description": "Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. Defaults to `false`.\n" }, "expirationInDays": { "type": "integer", "description": "Number of days until a certificate expires. Must be between 1 and 5000.\n" }, "s3BucketName": { "type": "string", "description": "Name of the S3 bucket that contains the CRL. If you do not provide a value for the `custom_cname` argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket. Must be between 3 and 255 characters in length.\n" }, "s3ObjectAcl": { "type": "string", "description": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. Defaults to `PUBLIC_READ`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "s3ObjectAcl" ] } } }, "aws:acmpca/CertificateAuthorityRevocationConfigurationOcspConfiguration:CertificateAuthorityRevocationConfigurationOcspConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Boolean value that specifies whether a custom OCSP responder is enabled.\n" }, "ocspCustomCname": { "type": "string", "description": "CNAME specifying a customized OCSP domain. Note: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:acmpca/CertificateValidity:CertificateValidity": { "properties": { "type": { "type": "string", "description": "Determines how `value` is interpreted. Valid values: `DAYS`, `MONTHS`, `YEARS`, `ABSOLUTE`, `END_DATE`.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "If `type` is `DAYS`, `MONTHS`, or `YEARS`, the relative time until the certificate expires. If `type` is `ABSOLUTE`, the date in seconds since the Unix epoch. If `type` is `END_DATE`, the date in RFC 3339 format.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type", "value" ] }, "aws:acmpca/getCertificateAuthorityRevocationConfiguration:getCertificateAuthorityRevocationConfiguration": { "properties": { "crlConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:acmpca/getCertificateAuthorityRevocationConfigurationCrlConfiguration:getCertificateAuthorityRevocationConfigurationCrlConfiguration" }, "description": "Nested attribute containing configuration of the certificate revocation list (CRL), if any, maintained by the certificate authority.\n" }, "ocspConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:acmpca/getCertificateAuthorityRevocationConfigurationOcspConfiguration:getCertificateAuthorityRevocationConfigurationOcspConfiguration" } } }, "type": "object", "required": [ "crlConfigurations", "ocspConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:acmpca/getCertificateAuthorityRevocationConfigurationCrlConfiguration:getCertificateAuthorityRevocationConfigurationCrlConfiguration": { "properties": { "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.\n" }, "enabled": { "type": "boolean", "description": "Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.\n" }, "expirationInDays": { "type": "integer", "description": "Number of days until a certificate expires.\n" }, "s3BucketName": { "type": "string", "description": "Name of the S3 bucket that contains the CRL.\n" }, "s3ObjectAcl": { "type": "string", "description": "Whether the CRL is publicly readable or privately held in the CRL Amazon S3 bucket.\n" } }, "type": "object", "required": [ "customCname", "enabled", "expirationInDays", "s3BucketName", "s3ObjectAcl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:acmpca/getCertificateAuthorityRevocationConfigurationOcspConfiguration:getCertificateAuthorityRevocationConfigurationOcspConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Boolean value that specifies whether a custom OCSP responder is enabled.\n" }, "ocspCustomCname": { "type": "string", "description": "A CNAME specifying a customized OCSP domain.\n" } }, "type": "object", "required": [ "enabled", "ocspCustomCname" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/IpAddressType:IpAddressType": { "type": "string", "enum": [ { "name": "Ipv4", "value": "ipv4" }, { "name": "Dualstack", "value": "dualstack" } ] }, "aws:alb/ListenerDefaultAction:ListenerDefaultAction": { "properties": { "authenticateCognito": { "$ref": "#/types/aws:alb/ListenerDefaultActionAuthenticateCognito:ListenerDefaultActionAuthenticateCognito", "description": "Configuration block for using Amazon Cognito to authenticate users. Specify only when `type` is `authenticate-cognito`. See below.\n" }, "authenticateOidc": { "$ref": "#/types/aws:alb/ListenerDefaultActionAuthenticateOidc:ListenerDefaultActionAuthenticateOidc", "description": "Configuration block for an identity provider that is compliant with OpenID Connect (OIDC). Specify only when `type` is `authenticate-oidc`. See below.\n" }, "fixedResponse": { "$ref": "#/types/aws:alb/ListenerDefaultActionFixedResponse:ListenerDefaultActionFixedResponse", "description": "Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`.\n" }, "forward": { "$ref": "#/types/aws:alb/ListenerDefaultActionForward:ListenerDefaultActionForward", "description": "Configuration block for creating an action that distributes requests among one or more target groups. Specify only if `type` is `forward`. See below.\n" }, "order": { "type": "integer", "description": "Order for the action. The action with the lowest value for order is performed first. Valid values are between `1` and `50000`. Defaults to the position in the list of actions.\n" }, "redirect": { "$ref": "#/types/aws:alb/ListenerDefaultActionRedirect:ListenerDefaultActionRedirect", "description": "Configuration block for creating a redirect action. Required if `type` is `redirect`. See below.\n" }, "targetGroupArn": { "type": "string", "description": "ARN of the Target Group to which to route traffic. Specify only if `type` is `forward` and you want to route to a single target group. To route to one or more target groups, use a `forward` block instead. Can be specified with `forward` but ARNs must match.\n" }, "type": { "type": "string", "description": "Type of routing action. Valid values are `forward`, `redirect`, `fixed-response`, `authenticate-cognito` and `authenticate-oidc`.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "order", "type" ] } } }, "aws:alb/ListenerDefaultActionAuthenticateCognito:ListenerDefaultActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Query parameters to include in the redirect request to the authorization endpoint. Max: 10. See below.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior if the user is not authenticated. Valid values are `deny`, `allow` and `authenticate`.\n" }, "scope": { "type": "string", "description": "Set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session, in seconds.\n" }, "userPoolArn": { "type": "string", "description": "ARN of the Cognito user pool.\n" }, "userPoolClientId": { "type": "string", "description": "ID of the Cognito user pool client.\n" }, "userPoolDomain": { "type": "string", "description": "Domain prefix or fully-qualified domain name of the Cognito user pool.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredOutputs": [ "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "userPoolArn", "userPoolClientId", "userPoolDomain" ] } } }, "aws:alb/ListenerDefaultActionAuthenticateOidc:ListenerDefaultActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "authorizationEndpoint": { "type": "string", "description": "Authorization endpoint of the IdP.\n" }, "clientId": { "type": "string", "description": "OAuth 2.0 client identifier.\n" }, "clientSecret": { "type": "string", "description": "OAuth 2.0 client secret.\n", "secret": true }, "issuer": { "type": "string", "description": "OIDC issuer identifier of the IdP.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "Set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session, in seconds.\n" }, "tokenEndpoint": { "type": "string", "description": "Token endpoint of the IdP.\n" }, "userInfoEndpoint": { "type": "string", "description": "User info endpoint of the IdP.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredOutputs": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "tokenEndpoint", "userInfoEndpoint" ] } } }, "aws:alb/ListenerDefaultActionFixedResponse:ListenerDefaultActionFixedResponse": { "properties": { "contentType": { "type": "string", "description": "Content type. Valid values are `text/plain`, `text/css`, `text/html`, `application/javascript` and `application/json`.\n\nThe following arguments are optional:\n" }, "messageBody": { "type": "string", "description": "Message body.\n" }, "statusCode": { "type": "string", "description": "HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`.\n" } }, "type": "object", "required": [ "contentType" ], "language": { "nodejs": { "requiredOutputs": [ "contentType", "statusCode" ] } } }, "aws:alb/ListenerDefaultActionForward:ListenerDefaultActionForward": { "properties": { "stickiness": { "$ref": "#/types/aws:alb/ListenerDefaultActionForwardStickiness:ListenerDefaultActionForwardStickiness", "description": "Configuration block for target group stickiness for the rule. See below.\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:alb/ListenerDefaultActionForwardTargetGroup:ListenerDefaultActionForwardTargetGroup" }, "description": "Set of 1-5 target group blocks. See below.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "targetGroups" ] }, "aws:alb/ListenerDefaultActionForwardStickiness:ListenerDefaultActionForwardStickiness": { "properties": { "duration": { "type": "integer", "description": "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).\n\nThe following arguments are optional:\n" }, "enabled": { "type": "boolean", "description": "Whether target group stickiness is enabled. Default is `false`.\n" } }, "type": "object", "required": [ "duration" ] }, "aws:alb/ListenerDefaultActionForwardTargetGroup:ListenerDefaultActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the target group.\n\nThe following arguments are optional:\n" }, "weight": { "type": "integer", "description": "Weight. The range is 0 to 999.\n" } }, "type": "object", "required": [ "arn" ] }, "aws:alb/ListenerDefaultActionRedirect:ListenerDefaultActionRedirect": { "properties": { "host": { "type": "string", "description": "Hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`.\n" }, "path": { "type": "string", "description": "Absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to `/#{path}`.\n" }, "port": { "type": "string", "description": "Port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`.\n" }, "protocol": { "type": "string", "description": "Protocol. Valid values are `HTTP`, `HTTPS`, or `#{protocol}`. Defaults to `#{protocol}`.\n" }, "query": { "type": "string", "description": "Query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\". Defaults to `#{query}`.\n" }, "statusCode": { "type": "string", "description": "HTTP redirect code. The redirect is either permanent (`HTTP_301`) or temporary (`HTTP_302`).\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "statusCode" ] }, "aws:alb/ListenerMutualAuthentication:ListenerMutualAuthentication": { "properties": { "advertiseTrustStoreCaNames": { "type": "string", "description": "Valid values are `off` and `on`.\n" }, "ignoreClientCertificateExpiry": { "type": "boolean", "description": "Whether client certificate expiry is ignored. Default is `false`.\n" }, "mode": { "type": "string", "description": "Valid values are `off`, `verify` and `passthrough`.\n" }, "trustStoreArn": { "type": "string", "description": "ARN of the elbv2 Trust Store.\n" } }, "type": "object", "required": [ "mode" ], "language": { "nodejs": { "requiredOutputs": [ "advertiseTrustStoreCaNames", "mode" ] } } }, "aws:alb/ListenerRuleAction:ListenerRuleAction": { "properties": { "authenticateCognito": { "$ref": "#/types/aws:alb/ListenerRuleActionAuthenticateCognito:ListenerRuleActionAuthenticateCognito", "description": "Information for creating an authenticate action using Cognito. Required if `type` is `authenticate-cognito`.\n" }, "authenticateOidc": { "$ref": "#/types/aws:alb/ListenerRuleActionAuthenticateOidc:ListenerRuleActionAuthenticateOidc", "description": "Information for creating an authenticate action using OIDC. Required if `type` is `authenticate-oidc`.\n" }, "fixedResponse": { "$ref": "#/types/aws:alb/ListenerRuleActionFixedResponse:ListenerRuleActionFixedResponse", "description": "Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`.\n" }, "forward": { "$ref": "#/types/aws:alb/ListenerRuleActionForward:ListenerRuleActionForward", "description": "Configuration block for creating an action that distributes requests among one or more target groups.\nSpecify only if `type` is `forward`.\nCannot be specified with `target_group_arn`.\n" }, "order": { "type": "integer", "description": "Order for the action.\nThe action with the lowest value for order is performed first.\nValid values are between `1` and `50000`.\nDefaults to the position in the list of actions.\n" }, "redirect": { "$ref": "#/types/aws:alb/ListenerRuleActionRedirect:ListenerRuleActionRedirect", "description": "Information for creating a redirect action. Required if `type` is `redirect`.\n" }, "targetGroupArn": { "type": "string", "description": "ARN of the Target Group to which to route traffic.\nSpecify only if `type` is `forward` and you want to route to a single target group.\nTo route to one or more target groups, use a `forward` block instead.\nCannot be specified with `forward`.\n" }, "type": { "type": "string", "description": "The type of routing action. Valid values are `forward`, `redirect`, `fixed-response`, `authenticate-cognito` and `authenticate-oidc`.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "order", "type" ] } } }, "aws:alb/ListenerRuleActionAuthenticateCognito:ListenerRuleActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "The maximum duration of the authentication session, in seconds.\n" }, "userPoolArn": { "type": "string", "description": "The ARN of the Cognito user pool.\n" }, "userPoolClientId": { "type": "string", "description": "The ID of the Cognito user pool client.\n" }, "userPoolDomain": { "type": "string", "description": "The domain prefix or fully-qualified domain name of the Cognito user pool.\n" } }, "type": "object", "required": [ "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredOutputs": [ "onUnauthenticatedRequest", "userPoolArn", "userPoolClientId", "userPoolDomain" ] } } }, "aws:alb/ListenerRuleActionAuthenticateOidc:ListenerRuleActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "authorizationEndpoint": { "type": "string", "description": "The authorization endpoint of the IdP.\n" }, "clientId": { "type": "string", "description": "The OAuth 2.0 client identifier.\n" }, "clientSecret": { "type": "string", "description": "The OAuth 2.0 client secret.\n", "secret": true }, "issuer": { "type": "string", "description": "The OIDC issuer identifier of the IdP.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "The maximum duration of the authentication session, in seconds.\n" }, "tokenEndpoint": { "type": "string", "description": "The token endpoint of the IdP.\n" }, "userInfoEndpoint": { "type": "string", "description": "The user info endpoint of the IdP.\n" } }, "type": "object", "required": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredOutputs": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "tokenEndpoint", "userInfoEndpoint" ] } } }, "aws:alb/ListenerRuleActionFixedResponse:ListenerRuleActionFixedResponse": { "properties": { "contentType": { "type": "string", "description": "The content type. Valid values are `text/plain`, `text/css`, `text/html`, `application/javascript` and `application/json`.\n" }, "messageBody": { "type": "string", "description": "The message body.\n" }, "statusCode": { "type": "string", "description": "The HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`.\n" } }, "type": "object", "required": [ "contentType" ], "language": { "nodejs": { "requiredOutputs": [ "contentType", "statusCode" ] } } }, "aws:alb/ListenerRuleActionForward:ListenerRuleActionForward": { "properties": { "stickiness": { "$ref": "#/types/aws:alb/ListenerRuleActionForwardStickiness:ListenerRuleActionForwardStickiness", "description": "The target group stickiness for the rule.\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:alb/ListenerRuleActionForwardTargetGroup:ListenerRuleActionForwardTargetGroup" }, "description": "One or more target group blocks.\n" } }, "type": "object", "required": [ "targetGroups" ] }, "aws:alb/ListenerRuleActionForwardStickiness:ListenerRuleActionForwardStickiness": { "properties": { "duration": { "type": "integer", "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).\n" }, "enabled": { "type": "boolean", "description": "Indicates whether target group stickiness is enabled.\n" } }, "type": "object", "required": [ "duration" ] }, "aws:alb/ListenerRuleActionForwardTargetGroup:ListenerRuleActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the target group.\n" }, "weight": { "type": "integer", "description": "The weight. The range is 0 to 999.\n" } }, "type": "object", "required": [ "arn" ] }, "aws:alb/ListenerRuleActionRedirect:ListenerRuleActionRedirect": { "properties": { "host": { "type": "string", "description": "The hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`.\n" }, "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}. Defaults to `/#{path}`.\n" }, "port": { "type": "string", "description": "The port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`.\n" }, "protocol": { "type": "string", "description": "The protocol. Valid values are `HTTP`, `HTTPS`, or `#{protocol}`. Defaults to `#{protocol}`.\n" }, "query": { "type": "string", "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\". Defaults to `#{query}`.\n" }, "statusCode": { "type": "string", "description": "The HTTP redirect code. The redirect is either permanent (`HTTP_301`) or temporary (`HTTP_302`).\n" } }, "type": "object", "required": [ "statusCode" ] }, "aws:alb/ListenerRuleCondition:ListenerRuleCondition": { "properties": { "hostHeader": { "$ref": "#/types/aws:alb/ListenerRuleConditionHostHeader:ListenerRuleConditionHostHeader", "description": "Contains a single `values` item which is a list of host header patterns to match. The maximum size of each pattern is 128 characters. Comparison is case insensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). Only one pattern needs to match for the condition to be satisfied.\n" }, "httpHeader": { "$ref": "#/types/aws:alb/ListenerRuleConditionHttpHeader:ListenerRuleConditionHttpHeader", "description": "HTTP headers to match. HTTP Header block fields documented below.\n" }, "httpRequestMethod": { "$ref": "#/types/aws:alb/ListenerRuleConditionHttpRequestMethod:ListenerRuleConditionHttpRequestMethod", "description": "Contains a single `values` item which is a list of HTTP request methods or verbs to match. Maximum size is 40 characters. Only allowed characters are A-Z, hyphen (-) and underscore (\\_). Comparison is case sensitive. Wildcards are not supported. Only one needs to match for the condition to be satisfied. AWS recommends that GET and HEAD requests are routed in the same way because the response to a HEAD request may be cached.\n" }, "pathPattern": { "$ref": "#/types/aws:alb/ListenerRuleConditionPathPattern:ListenerRuleConditionPathPattern", "description": "Contains a single `values` item which is a list of path patterns to match against the request URL. Maximum size of each pattern is 128 characters. Comparison is case sensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). Only one pattern needs to match for the condition to be satisfied. Path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use a `query_string` condition.\n" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:alb/ListenerRuleConditionQueryString:ListenerRuleConditionQueryString" }, "description": "Query strings to match. Query String block fields documented below.\n" }, "sourceIp": { "$ref": "#/types/aws:alb/ListenerRuleConditionSourceIp:ListenerRuleConditionSourceIp", "description": "Contains a single `values` item which is a list of source IP CIDR notations to match. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. Condition is satisfied if the source IP address of the request matches one of the CIDR blocks. Condition is not satisfied by the addresses in the `X-Forwarded-For` header, use `http_header` condition instead.\n\n\u003e **NOTE::** Exactly one of `host_header`, `http_header`, `http_request_method`, `path_pattern`, `query_string` or `source_ip` must be set per condition.\n" } }, "type": "object" }, "aws:alb/ListenerRuleConditionHostHeader:ListenerRuleConditionHostHeader": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:alb/ListenerRuleConditionHttpHeader:ListenerRuleConditionHttpHeader": { "properties": { "httpHeaderName": { "type": "string", "description": "Name of HTTP header to search. The maximum size is 40 characters. Comparison is case insensitive. Only RFC7240 characters are supported. Wildcards are not supported. You cannot use HTTP header condition to specify the host header, use a `host-header` condition instead.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of header value patterns to match. Maximum size of each pattern is 128 characters. Comparison is case insensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If the same header appears multiple times in the request they will be searched in order until a match is found. Only one pattern needs to match for the condition to be satisfied. To require that all of the strings are a match, create one condition block per string.\n" } }, "type": "object", "required": [ "httpHeaderName", "values" ] }, "aws:alb/ListenerRuleConditionHttpRequestMethod:ListenerRuleConditionHttpRequestMethod": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:alb/ListenerRuleConditionPathPattern:ListenerRuleConditionPathPattern": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:alb/ListenerRuleConditionQueryString:ListenerRuleConditionQueryString": { "properties": { "key": { "type": "string", "description": "Query string key pattern to match.\n" }, "value": { "type": "string", "description": "Query string value pattern to match.\n" } }, "type": "object", "required": [ "value" ] }, "aws:alb/ListenerRuleConditionSourceIp:ListenerRuleConditionSourceIp": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:alb/LoadBalancerAccessLogs:LoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string", "description": "S3 bucket name to store the logs in.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `access_logs`. Defaults to `false`, even when `bucket` is specified.\n" }, "prefix": { "type": "string", "description": "S3 bucket prefix. Logs are stored in the root if not configured.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:alb/LoadBalancerConnectionLogs:LoadBalancerConnectionLogs": { "properties": { "bucket": { "type": "string", "description": "S3 bucket name to store the logs in.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `connection_logs`. Defaults to `false`, even when `bucket` is specified.\n" }, "prefix": { "type": "string", "description": "S3 bucket prefix. Logs are stored in the root if not configured.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:alb/LoadBalancerIpamPools:LoadBalancerIpamPools": { "properties": { "ipv4IpamPoolId": { "type": "string", "description": "The ID of the IPv4 IPAM pool.\n" } }, "type": "object", "required": [ "ipv4IpamPoolId" ] }, "aws:alb/LoadBalancerSubnetMapping:LoadBalancerSubnetMapping": { "properties": { "allocationId": { "type": "string", "description": "Allocation ID of the Elastic IP address for an internet-facing load balancer.\n" }, "ipv6Address": { "type": "string", "description": "IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.\n" }, "outpostId": { "type": "string" }, "privateIpv4Address": { "type": "string", "description": "Private IPv4 address for an internal load balancer.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "outpostId", "subnetId" ] } } }, "aws:alb/LoadBalancerType:LoadBalancerType": { "type": "string", "enum": [ { "name": "Application", "value": "application" }, { "name": "Network", "value": "network" } ] }, "aws:alb/TargetGroupHealthCheck:TargetGroupHealthCheck": { "properties": { "enabled": { "type": "boolean", "description": "Whether health checks are enabled. Defaults to `true`.\n" }, "healthyThreshold": { "type": "integer", "description": "Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.\n" }, "interval": { "type": "integer", "description": "Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For `lambda` target groups, it needs to be greater than the timeout of the underlying `lambda`. Defaults to 30.\n" }, "matcher": { "type": "string", "description": "The HTTP or gRPC codes to use when checking for a successful response from a target.\nThe `health_check.protocol` must be one of `HTTP` or `HTTPS` or the `target_type` must be `lambda`.\nValues can be comma-separated individual values (e.g., \"200,202\") or a range of values (e.g., \"200-299\").\n* For gRPC-based target groups (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is `GRPC`), values can be between `0` and `99`. The default is `12`.\n* When used with an Application Load Balancer (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is not `GRPC`), values can be between `200` and `499`. The default is `200`.\n* When used with a Network Load Balancer (i.e., the `protocol` is one of `TCP`, `TCP_UDP`, `UDP`, or `TLS`), values can be between `200` and `599`. The default is `200-399`.\n* When the `target_type` is `lambda`, values can be between `200` and `499`. The default is `200`.\n" }, "path": { "type": "string", "description": "Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.\n* For HTTP and HTTPS health checks, the default is `/`.\n* For gRPC health checks, the default is `/AWS.ALB/healthcheck`.\n" }, "port": { "type": "string", "description": "The port the load balancer uses when performing health checks on targets.\nValid values are either `traffic-port`, to use the same port as the target group, or a valid port number between `1` and `65536`.\nDefault is `traffic-port`.\n" }, "protocol": { "type": "string", "description": "Protocol the load balancer uses when performing health checks on targets.\nMust be one of `TCP`, `HTTP`, or `HTTPS`.\nThe `TCP` protocol is not supported for health checks if the protocol of the target group is `HTTP` or `HTTPS`.\nDefault is `HTTP`.\nCannot be specified when the `target_type` is `lambda`.\n" }, "timeout": { "type": "integer", "description": "Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "matcher", "path", "timeout" ] } } }, "aws:alb/TargetGroupStickiness:TargetGroupStickiness": { "properties": { "cookieDuration": { "type": "integer", "description": "Only used when the type is `lb_cookie`. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).\n" }, "cookieName": { "type": "string", "description": "Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is `app_cookie`.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `stickiness`. Default is `true`.\n" }, "type": { "type": "string", "description": "The type of sticky sessions. The only current possible values are `lb_cookie`, `app_cookie` for ALBs, `source_ip` for NLBs, and `source_ip_dest_ip`, `source_ip_dest_ip_proto` for GWLBs.\n" } }, "type": "object", "required": [ "type" ] }, "aws:alb/TargetGroupTargetFailover:TargetGroupTargetFailover": { "properties": { "onDeregistration": { "type": "string", "description": "Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are `rebalance` and `no_rebalance`. Must match the attribute value set for `on_unhealthy`. Default: `no_rebalance`.\n" }, "onUnhealthy": { "type": "string", "description": "Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are `rebalance` and `no_rebalance`. Must match the attribute value set for `on_deregistration`. Default: `no_rebalance`.\n" } }, "type": "object", "required": [ "onDeregistration", "onUnhealthy" ] }, "aws:alb/TargetGroupTargetGroupHealth:TargetGroupTargetGroupHealth": { "properties": { "dnsFailover": { "$ref": "#/types/aws:alb/TargetGroupTargetGroupHealthDnsFailover:TargetGroupTargetGroupHealthDnsFailover", "description": "Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.\n" }, "unhealthyStateRouting": { "$ref": "#/types/aws:alb/TargetGroupTargetGroupHealthUnhealthyStateRouting:TargetGroupTargetGroupHealthUnhealthyStateRouting", "description": "Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.\n" } }, "type": "object" }, "aws:alb/TargetGroupTargetGroupHealthDnsFailover:TargetGroupTargetGroupHealthDnsFailover": { "properties": { "minimumHealthyTargetsCount": { "type": "string", "description": "The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are `off` or an integer from `1` to the maximum number of targets. The default is `off`.\n" }, "minimumHealthyTargetsPercentage": { "type": "string", "description": "The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are `off` or an integer from `1` to `100`. The default is `off`.\n" } }, "type": "object" }, "aws:alb/TargetGroupTargetGroupHealthUnhealthyStateRouting:TargetGroupTargetGroupHealthUnhealthyStateRouting": { "properties": { "minimumHealthyTargetsCount": { "type": "integer", "description": "The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are `1` to the maximum number of targets. The default is `1`.\n" }, "minimumHealthyTargetsPercentage": { "type": "string", "description": "The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are `off` or an integer from `1` to `100`. The default is `off`.\n" } }, "type": "object" }, "aws:alb/TargetGroupTargetHealthState:TargetGroupTargetHealthState": { "properties": { "enableUnhealthyConnectionTermination": { "type": "boolean", "description": "Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are `true` or `false`. Default: `true`.\n" }, "unhealthyDrainingInterval": { "type": "integer", "description": "Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is `0-360000`. This value has to be set only if `enable_unhealthy_connection_termination` is set to false. Default: `0`.\n" } }, "type": "object", "required": [ "enableUnhealthyConnectionTermination" ] }, "aws:alb/getListenerDefaultAction:getListenerDefaultAction": { "properties": { "authenticateCognitos": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionAuthenticateCognito:getListenerDefaultActionAuthenticateCognito" } }, "authenticateOidcs": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionAuthenticateOidc:getListenerDefaultActionAuthenticateOidc" } }, "fixedResponses": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionFixedResponse:getListenerDefaultActionFixedResponse" } }, "forwards": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionForward:getListenerDefaultActionForward" } }, "order": { "type": "integer" }, "redirects": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionRedirect:getListenerDefaultActionRedirect" } }, "targetGroupArn": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "required": [ "authenticateCognitos", "authenticateOidcs", "fixedResponses", "forwards", "order", "redirects", "targetGroupArn", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionAuthenticateCognito:getListenerDefaultActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" } }, "onUnauthenticatedRequest": { "type": "string" }, "scope": { "type": "string" }, "sessionCookieName": { "type": "string" }, "sessionTimeout": { "type": "integer" }, "userPoolArn": { "type": "string" }, "userPoolClientId": { "type": "string" }, "userPoolDomain": { "type": "string" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionAuthenticateOidc:getListenerDefaultActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" } }, "authorizationEndpoint": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "issuer": { "type": "string" }, "onUnauthenticatedRequest": { "type": "string" }, "scope": { "type": "string" }, "sessionCookieName": { "type": "string" }, "sessionTimeout": { "type": "integer" }, "tokenEndpoint": { "type": "string" }, "userInfoEndpoint": { "type": "string" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionFixedResponse:getListenerDefaultActionFixedResponse": { "properties": { "contentType": { "type": "string" }, "messageBody": { "type": "string" }, "statusCode": { "type": "string" } }, "type": "object", "required": [ "contentType", "messageBody", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionForward:getListenerDefaultActionForward": { "properties": { "stickinesses": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionForwardStickiness:getListenerDefaultActionForwardStickiness" } }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:alb/getListenerDefaultActionForwardTargetGroup:getListenerDefaultActionForwardTargetGroup" } } }, "type": "object", "required": [ "stickinesses", "targetGroups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionForwardStickiness:getListenerDefaultActionForwardStickiness": { "properties": { "duration": { "type": "integer" }, "enabled": { "type": "boolean" } }, "type": "object", "required": [ "duration", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionForwardTargetGroup:getListenerDefaultActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the listener. Required if `load_balancer_arn` and `port` is not set.\n" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "arn", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerDefaultActionRedirect:getListenerDefaultActionRedirect": { "properties": { "host": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "string", "description": "Port of the listener. Required if `arn` is not set.\n" }, "protocol": { "type": "string" }, "query": { "type": "string" }, "statusCode": { "type": "string" } }, "type": "object", "required": [ "host", "path", "port", "protocol", "query", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getListenerMutualAuthentication:getListenerMutualAuthentication": { "properties": { "advertiseTrustStoreCaNames": { "type": "string" }, "ignoreClientCertificateExpiry": { "type": "boolean" }, "mode": { "type": "string" }, "trustStoreArn": { "type": "string" } }, "type": "object", "required": [ "advertiseTrustStoreCaNames", "ignoreClientCertificateExpiry", "mode", "trustStoreArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getLoadBalancerAccessLogs:getLoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string" }, "enabled": { "type": "boolean" }, "prefix": { "type": "string" } }, "type": "object", "required": [ "bucket", "enabled", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getLoadBalancerConnectionLog:getLoadBalancerConnectionLog": { "properties": { "bucket": { "type": "string" }, "enabled": { "type": "boolean" }, "prefix": { "type": "string" } }, "type": "object", "required": [ "bucket", "enabled", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getLoadBalancerIpamPool:getLoadBalancerIpamPool": { "properties": { "ipv4IpamPoolId": { "type": "string" } }, "type": "object", "required": [ "ipv4IpamPoolId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getLoadBalancerSubnetMapping:getLoadBalancerSubnetMapping": { "properties": { "allocationId": { "type": "string" }, "ipv6Address": { "type": "string" }, "outpostId": { "type": "string" }, "privateIpv4Address": { "type": "string" }, "subnetId": { "type": "string" } }, "type": "object", "required": [ "allocationId", "ipv6Address", "outpostId", "privateIpv4Address", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getTargetGroupHealthCheck:getTargetGroupHealthCheck": { "properties": { "enabled": { "type": "boolean" }, "healthyThreshold": { "type": "integer" }, "interval": { "type": "integer" }, "matcher": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "string" }, "protocol": { "type": "string" }, "timeout": { "type": "integer" }, "unhealthyThreshold": { "type": "integer" } }, "type": "object", "required": [ "enabled", "healthyThreshold", "interval", "matcher", "path", "port", "protocol", "timeout", "unhealthyThreshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:alb/getTargetGroupStickiness:getTargetGroupStickiness": { "properties": { "cookieDuration": { "type": "integer" }, "cookieName": { "type": "string" }, "enabled": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object", "required": [ "cookieDuration", "cookieName", "enabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:amp/ScraperDestination:ScraperDestination": { "properties": { "amp": { "$ref": "#/types/aws:amp/ScraperDestinationAmp:ScraperDestinationAmp", "description": "Configuration block for an Amazon Managed Prometheus workspace destination. See `amp`.\n" } }, "type": "object" }, "aws:amp/ScraperDestinationAmp:ScraperDestinationAmp": { "properties": { "workspaceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the prometheus workspace.\n" } }, "type": "object", "required": [ "workspaceArn" ] }, "aws:amp/ScraperRoleConfiguration:ScraperRoleConfiguration": { "properties": { "sourceRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the source role configuration. Must be an IAM role ARN.\n" }, "targetRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the target role configuration. Must be an IAM role ARN.\n" } }, "type": "object" }, "aws:amp/ScraperSource:ScraperSource": { "properties": { "eks": { "$ref": "#/types/aws:amp/ScraperSourceEks:ScraperSourceEks", "description": "Configuration block for an EKS cluster source. See `eks`.\n" } }, "type": "object" }, "aws:amp/ScraperSourceEks:ScraperSourceEks": { "properties": { "clusterArn": { "type": "string" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of the security group IDs for the Amazon EKS cluster VPC configuration.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs. Must be in at least two different availability zones.\n" } }, "type": "object", "required": [ "clusterArn", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "clusterArn", "securityGroupIds", "subnetIds" ] } } }, "aws:amp/ScraperTimeouts:ScraperTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:amp/WorkspaceLoggingConfiguration:WorkspaceLoggingConfiguration": { "properties": { "logGroupArn": { "type": "string", "description": "The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist.\n" } }, "type": "object", "required": [ "logGroupArn" ] }, "aws:amplify/AppAutoBranchCreationConfig:AppAutoBranchCreationConfig": { "properties": { "basicAuthCredentials": { "type": "string", "description": "Basic authorization credentials for the autocreated branch.\n", "secret": true }, "buildSpec": { "type": "string", "description": "Build specification (build spec) for the autocreated branch.\n" }, "enableAutoBuild": { "type": "boolean", "description": "Enables auto building for the autocreated branch.\n" }, "enableBasicAuth": { "type": "boolean", "description": "Enables basic authorization for the autocreated branch.\n" }, "enablePerformanceMode": { "type": "boolean", "description": "Enables performance mode for the branch.\n", "willReplaceOnChanges": true }, "enablePullRequestPreview": { "type": "boolean", "description": "Enables pull request previews for the autocreated branch.\n" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment variables for the autocreated branch.\n" }, "framework": { "type": "string", "description": "Framework for the autocreated branch.\n" }, "pullRequestEnvironmentName": { "type": "string", "description": "Amplify environment name for the pull request.\n" }, "stage": { "type": "string", "description": "Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.\n" } }, "type": "object" }, "aws:amplify/AppCacheConfig:AppCacheConfig": { "properties": { "type": { "type": "string", "description": "Type of cache configuration to use for an Amplify app. Valid values: `AMPLIFY_MANAGED`, `AMPLIFY_MANAGED_NO_COOKIES`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:amplify/AppCustomRule:AppCustomRule": { "properties": { "condition": { "type": "string", "description": "Condition for a URL rewrite or redirect rule, such as a country code.\n" }, "source": { "type": "string", "description": "Source pattern for a URL rewrite or redirect rule.\n" }, "status": { "type": "string", "description": "Status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`.\n" }, "target": { "type": "string", "description": "Target pattern for a URL rewrite or redirect rule.\n" } }, "type": "object", "required": [ "source", "target" ] }, "aws:amplify/AppProductionBranch:AppProductionBranch": { "properties": { "branchName": { "type": "string", "description": "Branch name for the production branch.\n" }, "lastDeployTime": { "type": "string", "description": "Last deploy time of the production branch.\n" }, "status": { "type": "string", "description": "Status of the production branch.\n" }, "thumbnailUrl": { "type": "string", "description": "Thumbnail URL for the production branch.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branchName", "lastDeployTime", "status", "thumbnailUrl" ] } } }, "aws:amplify/DomainAssociationCertificateSettings:DomainAssociationCertificateSettings": { "properties": { "certificateVerificationDnsRecord": { "type": "string", "description": "DNS records for certificate verification in a space-delimited format (`\u003crecord\u003e CNAME \u003ctarget\u003e`).\n" }, "customCertificateArn": { "type": "string", "description": "The Amazon resource name (ARN) for the custom certificate.\nRequired when `type` is `CUSTOM`.\n" }, "type": { "type": "string", "description": "The certificate type.\nValid values are `AMPLIFY_MANAGED` and `CUSTOM`.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "certificateVerificationDnsRecord", "type" ] } } }, "aws:amplify/DomainAssociationSubDomain:DomainAssociationSubDomain": { "properties": { "branchName": { "type": "string", "description": "Branch name setting for the subdomain.\n" }, "dnsRecord": { "type": "string", "description": "DNS record for the subdomain in a space-prefixed and space-delimited format (` CNAME \u003ctarget\u003e`).\n" }, "prefix": { "type": "string", "description": "Prefix setting for the subdomain.\n" }, "verified": { "type": "boolean", "description": "Verified status of the subdomain.\n" } }, "type": "object", "required": [ "branchName", "prefix" ], "language": { "nodejs": { "requiredOutputs": [ "branchName", "dnsRecord", "prefix", "verified" ] } } }, "aws:apigateway/AccountThrottleSetting:AccountThrottleSetting": { "properties": { "burstLimit": { "type": "integer", "description": "Absolute maximum number of times API Gateway allows the API to be called per second (RPS).\n" }, "rateLimit": { "type": "number", "description": "Number of times API Gateway allows the API to be called per second on average (RPS).\n" } }, "type": "object", "required": [ "burstLimit", "rateLimit" ] }, "aws:apigateway/DeploymentCanarySettings:DeploymentCanarySettings": { "properties": { "percentTraffic": { "type": "number", "description": "Percentage (0.0-100.0) of traffic routed to the canary deployment.\n" }, "stageVariableOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "description": "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.\n" }, "useStageCache": { "type": "boolean", "description": "Boolean flag to indicate whether the canary release deployment uses the stage cache or not.\n" } }, "type": "object" }, "aws:apigateway/DocumentationPartLocation:DocumentationPartLocation": { "properties": { "method": { "type": "string", "description": "HTTP verb of a method. The default value is `*` for any method.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the targeted API entity.\n", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "URL path of the target. The default value is `/` for the root resource.\n", "willReplaceOnChanges": true }, "statusCode": { "type": "string", "description": "HTTP status code of a response. The default value is `*` for any status code.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of API entity to which the documentation content appliesE.g., `API`, `METHOD` or `REQUEST_BODY`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "aws:apigateway/DomainNameEndpointConfiguration:DomainNameEndpointConfiguration": { "properties": { "types": { "type": "string", "description": "A list of endpoint types of an API or its custom domain name. 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`.\n" } }, "type": "object", "required": [ "types" ] }, "aws:apigateway/DomainNameMutualTlsAuthentication:DomainNameMutualTlsAuthentication": { "properties": { "truststoreUri": { "type": "string", "description": "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.\n" }, "truststoreVersion": { "type": "string", "description": "Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.\n" } }, "type": "object", "required": [ "truststoreUri" ] }, "aws:apigateway/IntegrationTlsConfig:IntegrationTlsConfig": { "properties": { "insecureSkipVerification": { "type": "boolean", "description": "Whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a [supported certificate authority](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html). This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for `HTTP` and `HTTP_PROXY` integrations.\n" } }, "type": "object" }, "aws:apigateway/MethodSettingsSettings:MethodSettingsSettings": { "properties": { "cacheDataEncrypted": { "type": "boolean", "description": "Whether the cached responses are encrypted.\n" }, "cacheTtlInSeconds": { "type": "integer", "description": "Time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.\n" }, "cachingEnabled": { "type": "boolean", "description": "Whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.\n" }, "dataTraceEnabled": { "type": "boolean", "description": "Whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.\n" }, "loggingLevel": { "type": "string", "description": "Logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The available levels are `OFF`, `ERROR`, and `INFO`.\n" }, "metricsEnabled": { "type": "boolean", "description": "Whether Amazon CloudWatch metrics are enabled for this method.\n" }, "requireAuthorizationForCacheControl": { "type": "boolean", "description": "Whether authorization is required for a cache invalidation request.\n" }, "throttlingBurstLimit": { "type": "integer", "description": "Throttling burst limit. Default: `-1` (throttling disabled).\n" }, "throttlingRateLimit": { "type": "number", "description": "Throttling rate limit. Default: `-1` (throttling disabled).\n" }, "unauthorizedCacheControlHeaderStrategy": { "type": "string", "description": "How to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheDataEncrypted", "cacheTtlInSeconds", "cachingEnabled", "dataTraceEnabled", "loggingLevel", "metricsEnabled", "requireAuthorizationForCacheControl", "unauthorizedCacheControlHeaderStrategy" ] } } }, "aws:apigateway/RestApiEndpointConfiguration:RestApiEndpointConfiguration": { "properties": { "types": { "type": "string", "description": "List of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE`, `REGIONAL` or `PRIVATE`. If unspecified, defaults to `EDGE`. If set to `PRIVATE` recommend to set `put_rest_api_mode` = `merge` to not cause the endpoints and associated Route53 records to be deleted. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.\n" }, "vpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "Set of VPC Endpoint identifiers. It is only supported for `PRIVATE` endpoint type. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-endpoint-configuration` extension `vpcEndpointIds` property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is provided and is different than the OpenAPI value, **the argument value will override the OpenAPI value**.\n" } }, "type": "object", "required": [ "types" ], "language": { "nodejs": { "requiredOutputs": [ "types", "vpcEndpointIds" ] } } }, "aws:apigateway/RestApiPutTimeouts:RestApiPutTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:apigateway/StageAccessLogSettings:StageAccessLogSettings": { "properties": { "destinationArn": { "type": "string", "description": "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-`. Automatically removes trailing `:*` if present.\n" }, "format": { "type": "string", "description": "Formatting and values recorded in the logs.\nFor more information on configuring the log format rules visit the AWS [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)\n" } }, "type": "object", "required": [ "destinationArn", "format" ] }, "aws:apigateway/StageCanarySettings:StageCanarySettings": { "properties": { "deploymentId": { "type": "string", "description": "ID of the deployment that the canary points to.\n" }, "percentTraffic": { "type": "number", "description": "Percent `0.0` - `100.0` of traffic to divert to the canary deployment.\n" }, "stageVariableOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of overridden stage `variables` (including new variables) for the canary deployment.\n" }, "useStageCache": { "type": "boolean", "description": "Whether the canary deployment uses the stage cache. Defaults to false.\n" } }, "type": "object", "required": [ "deploymentId" ] }, "aws:apigateway/UsagePlanApiStage:UsagePlanApiStage": { "properties": { "apiId": { "type": "string", "description": "API Id of the associated API stage in a usage plan.\n" }, "stage": { "type": "string", "description": "API stage name of the associated API stage in a usage plan.\n" }, "throttles": { "type": "array", "items": { "$ref": "#/types/aws:apigateway/UsagePlanApiStageThrottle:UsagePlanApiStageThrottle" }, "description": "The throttling limits of the usage plan.\n" } }, "type": "object", "required": [ "apiId", "stage" ] }, "aws:apigateway/UsagePlanApiStageThrottle:UsagePlanApiStageThrottle": { "properties": { "burstLimit": { "type": "integer", "description": "The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.\n" }, "path": { "type": "string", "description": "Method to apply the throttle settings for. Specfiy the path and method, for example `/test/GET`.\n" }, "rateLimit": { "type": "number", "description": "The API request steady-state rate limit.\n" } }, "type": "object", "required": [ "path" ] }, "aws:apigateway/UsagePlanQuotaSettings:UsagePlanQuotaSettings": { "properties": { "limit": { "type": "integer", "description": "Maximum number of requests that can be made in a given time period.\n" }, "offset": { "type": "integer", "description": "Number of requests subtracted from the given limit in the initial time period.\n" }, "period": { "type": "string", "description": "Time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".\n" } }, "type": "object", "required": [ "limit", "period" ] }, "aws:apigateway/UsagePlanThrottleSettings:UsagePlanThrottleSettings": { "properties": { "burstLimit": { "type": "integer" }, "rateLimit": { "type": "number" } }, "type": "object" }, "aws:apigateway/getApiKeysItem:getApiKeysItem": { "properties": { "createdDate": { "type": "string", "description": "Date and time when the API Key was created.\n" }, "customerId": { "type": "string", "description": "Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.\n" }, "description": { "type": "string", "description": "Description of the API Key.\n" }, "enabled": { "type": "boolean", "description": "Whether the API Key is enabled.\n" }, "id": { "type": "string", "description": "ID of the API Key.\n" }, "lastUpdatedDate": { "type": "string", "description": "Date and time when the API Key was last updated.\n" }, "name": { "type": "string", "description": "Name of the API Key.\n" }, "stageKeys": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags for the resource.\n" }, "value": { "type": "string", "description": "Value of the API Key.\n" } }, "type": "object", "required": [ "createdDate", "customerId", "description", "enabled", "id", "lastUpdatedDate", "name", "stageKeys", "tags", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:apigateway/getDomainNameEndpointConfiguration:getDomainNameEndpointConfiguration": { "properties": { "types": { "type": "array", "items": { "type": "string" }, "description": "List of endpoint types.\n" } }, "type": "object", "required": [ "types" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:apigateway/getRestApiEndpointConfiguration:getRestApiEndpointConfiguration": { "properties": { "types": { "type": "array", "items": { "type": "string" } }, "vpcEndpointIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "types", "vpcEndpointIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:apigatewayv2/ApiCorsConfiguration:ApiCorsConfiguration": { "properties": { "allowCredentials": { "type": "boolean", "description": "Whether credentials are included in the CORS request.\n" }, "allowHeaders": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed HTTP headers.\n" }, "allowMethods": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed HTTP methods.\n" }, "allowOrigins": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed origins.\n" }, "exposeHeaders": { "type": "array", "items": { "type": "string" }, "description": "Set of exposed HTTP headers.\n" }, "maxAge": { "type": "integer", "description": "Number of seconds that the browser should cache preflight request results.\n" } }, "type": "object" }, "aws:apigatewayv2/AuthorizerJwtConfiguration:AuthorizerJwtConfiguration": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "List of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list.\n" }, "issuer": { "type": "string", "description": "Base domain of the identity provider that issues JSON Web Tokens, such as the `endpoint` attribute of the `aws.cognito.UserPool` resource.\n" } }, "type": "object" }, "aws:apigatewayv2/DomainNameDomainNameConfiguration:DomainNameDomainNameConfiguration": { "properties": { "certificateArn": { "type": "string", "description": "ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the `aws.acm.Certificate` resource to configure an ACM certificate.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Valid values: `REGIONAL`.\n" }, "hostedZoneId": { "type": "string", "description": "Amazon Route 53 Hosted Zone ID of the endpoint.\n" }, "ownershipVerificationCertificateArn": { "type": "string", "description": "ARN of the AWS-issued certificate used to validate custom domain ownership (when `certificate_arn` is issued via an ACM Private CA or `mutual_tls_authentication` is configured with an ACM-imported certificate.)\n" }, "securityPolicy": { "type": "string", "description": "Transport Layer Security (TLS) version of the [security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html) for the domain name. Valid values: `TLS_1_2`.\n" }, "targetDomainName": { "type": "string", "description": "Target domain name.\n" } }, "type": "object", "required": [ "certificateArn", "endpointType", "securityPolicy" ], "language": { "nodejs": { "requiredOutputs": [ "certificateArn", "endpointType", "hostedZoneId", "ownershipVerificationCertificateArn", "securityPolicy", "targetDomainName" ] } } }, "aws:apigatewayv2/DomainNameMutualTlsAuthentication:DomainNameMutualTlsAuthentication": { "properties": { "truststoreUri": { "type": "string", "description": "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.\n" }, "truststoreVersion": { "type": "string", "description": "Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.\n" } }, "type": "object", "required": [ "truststoreUri" ] }, "aws:apigatewayv2/IntegrationResponseParameter:IntegrationResponseParameter": { "properties": { "mappings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value map. The key of this map identifies the location of the request parameter to change, and how to change it. The corresponding value specifies the new data for the parameter.\nSee the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) for details.\n" }, "statusCode": { "type": "string", "description": "HTTP status code in the range 200-599.\n" } }, "type": "object", "required": [ "mappings", "statusCode" ] }, "aws:apigatewayv2/IntegrationTlsConfig:IntegrationTlsConfig": { "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.\n" } }, "type": "object" }, "aws:apigatewayv2/RouteRequestParameter:RouteRequestParameter": { "properties": { "requestParameterKey": { "type": "string", "description": "Request parameter key. This is a [request data mapping parameter](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-data-mapping.html#websocket-mapping-request-parameters).\n" }, "required": { "type": "boolean", "description": "Boolean whether or not the parameter is required.\n" } }, "type": "object", "required": [ "requestParameterKey", "required" ] }, "aws:apigatewayv2/StageAccessLogSettings:StageAccessLogSettings": { "properties": { "destinationArn": { "type": "string", "description": "ARN of the CloudWatch Logs log group to receive access logs. Any trailing `:*` is trimmed from the ARN.\n" }, "format": { "type": "string", "description": "Single line [format](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#apigateway-cloudwatch-log-formats) of the access logs of data. Refer to log settings for [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging-variables.html) or [Websocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html).\n" } }, "type": "object", "required": [ "destinationArn", "format" ] }, "aws:apigatewayv2/StageDefaultRouteSettings:StageDefaultRouteSettings": { "properties": { "dataTraceEnabled": { "type": "boolean", "description": "Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs.\nDefaults to `false`. Supported only for WebSocket APIs.\n" }, "detailedMetricsEnabled": { "type": "boolean", "description": "Whether detailed metrics are enabled for the default route. Defaults to `false`.\n" }, "loggingLevel": { "type": "string", "description": "Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs.\nValid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.\n" }, "throttlingBurstLimit": { "type": "integer", "description": "Throttling burst limit for the default route.\n" }, "throttlingRateLimit": { "type": "number", "description": "Throttling rate limit for the default route.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "loggingLevel" ] } } }, "aws:apigatewayv2/StageRouteSetting:StageRouteSetting": { "properties": { "dataTraceEnabled": { "type": "boolean", "description": "Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs.\nDefaults to `false`. Supported only for WebSocket APIs.\n" }, "detailedMetricsEnabled": { "type": "boolean", "description": "Whether detailed metrics are enabled for the route. Defaults to `false`.\n" }, "loggingLevel": { "type": "string", "description": "Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs.\nValid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.\n" }, "routeKey": { "type": "string", "description": "Route key.\n" }, "throttlingBurstLimit": { "type": "integer", "description": "Throttling burst limit for the route.\n" }, "throttlingRateLimit": { "type": "number", "description": "Throttling rate limit for the route.\n" } }, "type": "object", "required": [ "routeKey" ], "language": { "nodejs": { "requiredOutputs": [ "loggingLevel", "routeKey" ] } } }, "aws:apigatewayv2/getApiCorsConfiguration:getApiCorsConfiguration": { "properties": { "allowCredentials": { "type": "boolean", "description": "Whether credentials are included in the CORS request.\n" }, "allowHeaders": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed HTTP headers.\n" }, "allowMethods": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed HTTP methods.\n" }, "allowOrigins": { "type": "array", "items": { "type": "string" }, "description": "Set of allowed origins.\n" }, "exposeHeaders": { "type": "array", "items": { "type": "string" }, "description": "Set of exposed HTTP headers.\n" }, "maxAge": { "type": "integer", "description": "Number of seconds that the browser should cache preflight request results.\n" } }, "type": "object", "required": [ "allowCredentials", "allowHeaders", "allowMethods", "allowOrigins", "exposeHeaders", "maxAge" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appautoscaling/PolicyStepScalingPolicyConfiguration:PolicyStepScalingPolicyConfiguration": { "properties": { "adjustmentType": { "type": "string", "description": "Whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.\n" }, "cooldown": { "type": "integer", "description": "Amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.\n" }, "metricAggregationType": { "type": "string", "description": "Aggregation type for the policy's metrics. Valid values are \"Minimum\", \"Maximum\", and \"Average\". Without a value, AWS will treat the aggregation type as \"Average\".\n" }, "minAdjustmentMagnitude": { "type": "integer", "description": "Minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.\n" }, "stepAdjustments": { "type": "array", "items": { "$ref": "#/types/aws:appautoscaling/PolicyStepScalingPolicyConfigurationStepAdjustment:PolicyStepScalingPolicyConfigurationStepAdjustment" }, "description": "Set of adjustments that manage scaling. These have the following structure:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst ecsPolicy = new aws.appautoscaling.Policy(\"ecs_policy\", {stepScalingPolicyConfiguration: {\n stepAdjustments: [\n {\n metricIntervalLowerBound: \"1\",\n metricIntervalUpperBound: \"2\",\n scalingAdjustment: -1,\n },\n {\n metricIntervalLowerBound: \"2\",\n metricIntervalUpperBound: \"3\",\n scalingAdjustment: 1,\n },\n ],\n}});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\necs_policy = aws.appautoscaling.Policy(\"ecs_policy\", step_scaling_policy_configuration={\n \"step_adjustments\": [\n {\n \"metric_interval_lower_bound\": \"1\",\n \"metric_interval_upper_bound\": \"2\",\n \"scaling_adjustment\": -1,\n },\n {\n \"metric_interval_lower_bound\": \"2\",\n \"metric_interval_upper_bound\": \"3\",\n \"scaling_adjustment\": 1,\n },\n ],\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ecsPolicy = new Aws.AppAutoScaling.Policy(\"ecs_policy\", new()\n {\n StepScalingPolicyConfiguration = new Aws.AppAutoScaling.Inputs.PolicyStepScalingPolicyConfigurationArgs\n {\n StepAdjustments = new[]\n {\n new Aws.AppAutoScaling.Inputs.PolicyStepScalingPolicyConfigurationStepAdjustmentArgs\n {\n MetricIntervalLowerBound = \"1\",\n MetricIntervalUpperBound = \"2\",\n ScalingAdjustment = -1,\n },\n new Aws.AppAutoScaling.Inputs.PolicyStepScalingPolicyConfigurationStepAdjustmentArgs\n {\n MetricIntervalLowerBound = \"2\",\n MetricIntervalUpperBound = \"3\",\n ScalingAdjustment = 1,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appautoscaling\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := appautoscaling.NewPolicy(ctx, \"ecs_policy\", \u0026appautoscaling.PolicyArgs{\n\t\t\tStepScalingPolicyConfiguration: \u0026appautoscaling.PolicyStepScalingPolicyConfigurationArgs{\n\t\t\t\tStepAdjustments: appautoscaling.PolicyStepScalingPolicyConfigurationStepAdjustmentArray{\n\t\t\t\t\t\u0026appautoscaling.PolicyStepScalingPolicyConfigurationStepAdjustmentArgs{\n\t\t\t\t\t\tMetricIntervalLowerBound: pulumi.String(\"1\"),\n\t\t\t\t\t\tMetricIntervalUpperBound: pulumi.String(\"2\"),\n\t\t\t\t\t\tScalingAdjustment: pulumi.Int(-1),\n\t\t\t\t\t},\n\t\t\t\t\t\u0026appautoscaling.PolicyStepScalingPolicyConfigurationStepAdjustmentArgs{\n\t\t\t\t\t\tMetricIntervalLowerBound: pulumi.String(\"2\"),\n\t\t\t\t\t\tMetricIntervalUpperBound: pulumi.String(\"3\"),\n\t\t\t\t\t\tScalingAdjustment: pulumi.Int(1),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.appautoscaling.Policy;\nimport com.pulumi.aws.appautoscaling.PolicyArgs;\nimport com.pulumi.aws.appautoscaling.inputs.PolicyStepScalingPolicyConfigurationArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ecsPolicy = new Policy(\"ecsPolicy\", PolicyArgs.builder()\n .stepScalingPolicyConfiguration(PolicyStepScalingPolicyConfigurationArgs.builder()\n .stepAdjustments( \n PolicyStepScalingPolicyConfigurationStepAdjustmentArgs.builder()\n .metricIntervalLowerBound(\"1\")\n .metricIntervalUpperBound(\"2\")\n .scalingAdjustment(-1)\n .build(),\n PolicyStepScalingPolicyConfigurationStepAdjustmentArgs.builder()\n .metricIntervalLowerBound(\"2\")\n .metricIntervalUpperBound(\"3\")\n .scalingAdjustment(1)\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ecsPolicy:\n type: aws:appautoscaling:Policy\n name: ecs_policy\n properties:\n stepScalingPolicyConfiguration:\n stepAdjustments:\n - metricIntervalLowerBound: 1\n metricIntervalUpperBound: 2\n scalingAdjustment: -1\n - metricIntervalLowerBound: 2\n metricIntervalUpperBound: 3\n scalingAdjustment: 1\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" } }, "type": "object" }, "aws:appautoscaling/PolicyStepScalingPolicyConfigurationStepAdjustment:PolicyStepScalingPolicyConfigurationStepAdjustment": { "properties": { "metricIntervalLowerBound": { "type": "string", "description": "Lower bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as negative infinity.\n" }, "metricIntervalUpperBound": { "type": "string", "description": "Upper bound for the difference between the alarm threshold and the CloudWatch metric. Without a value, AWS will treat this bound as infinity. The upper bound must be greater than the lower bound.\n" }, "scalingAdjustment": { "type": "integer", "description": "Number of members by which to scale, when the adjustment bounds are breached. A positive value scales up. A negative value scales down.\n" } }, "type": "object", "required": [ "scalingAdjustment" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfiguration:PolicyTargetTrackingScalingPolicyConfiguration": { "properties": { "customizedMetricSpecification": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification", "description": "Custom CloudWatch metric. Documentation can be found at: [AWS Customized Metric Specification](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CustomizedMetricSpecification.html). See supported fields below.\n" }, "disableScaleIn": { "type": "boolean", "description": "Whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is `false`.\n" }, "predefinedMetricSpecification": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification:PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification", "description": "Predefined metric. See supported fields below.\n" }, "scaleInCooldown": { "type": "integer", "description": "Amount of time, in seconds, after a scale in activity completes before another scale in activity can start.\n" }, "scaleOutCooldown": { "type": "integer", "description": "Amount of time, in seconds, after a scale out activity completes before another scale out activity can start.\n" }, "targetValue": { "type": "number", "description": "Target value for the metric.\n" } }, "type": "object", "required": [ "targetValue" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecification": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetric:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetric" }, "description": "Metrics to include, as a metric data query.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" }, "statistic": { "type": "string", "description": "Statistic of the metric. Valid values: `Average`, `Minimum`, `Maximum`, `SampleCount`, and `Sum`.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object" }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetric:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetric": { "properties": { "expression": { "type": "string", "description": "Math expression used on the returned metric. You must specify either `expression` or `metric_stat`, but not both.\n" }, "id": { "type": "string", "description": "Short name for the metric used in target tracking scaling policy.\n" }, "label": { "type": "string", "description": "Human-readable label for this metric or expression.\n" }, "metricStat": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStat:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStat", "description": "Structure that defines CloudWatch metric to be used in target tracking scaling policy. You must specify either `expression` or `metric_stat`, but not both.\n" }, "returnData": { "type": "boolean", "description": "Boolean that indicates whether to return the timestamps and raw data values of this metric, the default is true\n" } }, "type": "object", "required": [ "id" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStat:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStat": { "properties": { "metric": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetric:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetric", "description": "Structure that defines the CloudWatch metric to return, including the metric name, namespace, and dimensions.\n" }, "stat": { "type": "string", "description": "Statistic of the metrics to return.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object", "required": [ "metric", "stat" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetric:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetric": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension:PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:appautoscaling/PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification:PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecification": { "properties": { "predefinedMetricType": { "type": "string", "description": "Metric type.\n" }, "resourceLabel": { "type": "string", "description": "Reserved for future use if the `predefined_metric_type` is not `ALBRequestCountPerTarget`. If the `predefined_metric_type` is `ALBRequestCountPerTarget`, you must specify this argument. Documentation can be found at: [AWS Predefined Scaling Metric Specification](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_PredefinedScalingMetricSpecification.html). Must be less than or equal to 1023 characters in length.\n" } }, "type": "object", "required": [ "predefinedMetricType" ] }, "aws:appautoscaling/ScheduledActionScalableTargetAction:ScheduledActionScalableTargetAction": { "properties": { "maxCapacity": { "type": "integer", "description": "Maximum capacity. At least one of `max_capacity` or `min_capacity` must be set.\n" }, "minCapacity": { "type": "integer", "description": "Minimum capacity. At least one of `min_capacity` or `max_capacity` must be set.\n" } }, "type": "object" }, "aws:appautoscaling/TargetSuspendedState:TargetSuspendedState": { "properties": { "dynamicScalingInSuspended": { "type": "boolean", "description": "Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Default is `false`.\n" }, "dynamicScalingOutSuspended": { "type": "boolean", "description": "Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Default is `false`.\n" }, "scheduledScalingSuspended": { "type": "boolean", "description": "Whether scheduled scaling is suspended. Default is `false`.\n" } }, "type": "object" }, "aws:appconfig/ConfigurationProfileValidator:ConfigurationProfileValidator": { "properties": { "content": { "type": "string", "description": "Either the JSON Schema content or the ARN of an AWS Lambda function.\n", "secret": true }, "type": { "type": "string", "description": "Type of validator. Valid values: `JSON_SCHEMA` and `LAMBDA`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:appconfig/EnvironmentMonitor:EnvironmentMonitor": { "properties": { "alarmArn": { "type": "string", "description": "ARN of the Amazon CloudWatch alarm.\n" }, "alarmRoleArn": { "type": "string", "description": "ARN of an IAM role for AWS AppConfig to monitor `alarm_arn`.\n" } }, "type": "object", "required": [ "alarmArn" ] }, "aws:appconfig/EventIntegrationEventFilter:EventIntegrationEventFilter": { "properties": { "source": { "type": "string", "description": "Source of the events.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "source" ] }, "aws:appconfig/ExtensionActionPoint:ExtensionActionPoint": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appconfig/ExtensionActionPointAction:ExtensionActionPointAction" }, "description": "An action defines the tasks the extension performs during the AppConfig workflow. Detailed below.\n" }, "point": { "type": "string", "description": "The point at which to perform the defined actions. Valid points are `PRE_CREATE_HOSTED_CONFIGURATION_VERSION`, `PRE_START_DEPLOYMENT`, `ON_DEPLOYMENT_START`, `ON_DEPLOYMENT_STEP`, `ON_DEPLOYMENT_BAKING`, `ON_DEPLOYMENT_COMPLETE`, `ON_DEPLOYMENT_ROLLED_BACK`.\n" } }, "type": "object", "required": [ "actions", "point" ] }, "aws:appconfig/ExtensionActionPointAction:ExtensionActionPointAction": { "properties": { "description": { "type": "string", "description": "Information about the action.\n" }, "name": { "type": "string", "description": "The action name.\n" }, "roleArn": { "type": "string", "description": "An Amazon Resource Name (ARN) for an Identity and Access Management assume role.\n" }, "uri": { "type": "string", "description": "The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.\n" } }, "type": "object", "required": [ "name", "uri" ] }, "aws:appconfig/ExtensionParameter:ExtensionParameter": { "properties": { "description": { "type": "string", "description": "Information about the parameter.\n" }, "name": { "type": "string", "description": "The parameter name.\n" }, "required": { "type": "boolean", "description": "Determines if a parameter value must be specified in the extension association.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appconfig/getConfigurationProfileValidator:getConfigurationProfileValidator": { "properties": { "content": { "type": "string", "description": "Either the JSON Schema content or the ARN of an AWS Lambda function.\n" }, "type": { "type": "string", "description": "Type of validator. Valid values: JSON_SCHEMA and LAMBDA.\n" } }, "type": "object", "required": [ "content", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appconfig/getEnvironmentMonitor:getEnvironmentMonitor": { "properties": { "alarmArn": { "type": "string", "description": "ARN of the Amazon CloudWatch alarm.\n" }, "alarmRoleArn": { "type": "string", "description": "ARN of an IAM role for AWS AppConfig to monitor.\n" } }, "type": "object", "required": [ "alarmArn", "alarmRoleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appfabric/AppAuthorizationConnectionAuthRequest:AppAuthorizationConnectionAuthRequest": { "properties": { "code": { "type": "string", "description": "The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..\n" }, "redirectUri": { "type": "string", "description": "The redirect URL that is specified in the AuthURL and the application client.\n" } }, "type": "object", "required": [ "code", "redirectUri" ] }, "aws:appfabric/AppAuthorizationConnectionTenant:AppAuthorizationConnectionTenant": { "properties": { "tenantDisplayName": { "type": "string" }, "tenantIdentifier": { "type": "string" } }, "type": "object", "required": [ "tenantDisplayName", "tenantIdentifier" ] }, "aws:appfabric/AppAuthorizationConnectionTimeouts:AppAuthorizationConnectionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:appfabric/AppAuthorizationCredential:AppAuthorizationCredential": { "properties": { "apiKeyCredentials": { "type": "array", "items": { "$ref": "#/types/aws:appfabric/AppAuthorizationCredentialApiKeyCredential:AppAuthorizationCredentialApiKeyCredential" }, "description": "Contains API key credential information.\n" }, "oauth2Credential": { "$ref": "#/types/aws:appfabric/AppAuthorizationCredentialOauth2Credential:AppAuthorizationCredentialOauth2Credential", "description": "Contains OAuth2 client credential information.\n" } }, "type": "object" }, "aws:appfabric/AppAuthorizationCredentialApiKeyCredential:AppAuthorizationCredentialApiKeyCredential": { "properties": { "apiKey": { "type": "string", "description": "Contains API key credential information.\n", "secret": true } }, "type": "object", "required": [ "apiKey" ] }, "aws:appfabric/AppAuthorizationCredentialOauth2Credential:AppAuthorizationCredentialOauth2Credential": { "properties": { "clientId": { "type": "string", "description": "The client ID of the client application.\n" }, "clientSecret": { "type": "string", "description": "The client secret of the client application.\n", "secret": true } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appfabric/AppAuthorizationTenant:AppAuthorizationTenant": { "properties": { "tenantDisplayName": { "type": "string", "description": "The display name of the tenant.\n" }, "tenantIdentifier": { "type": "string", "description": "The ID of the application tenant.\n" } }, "type": "object", "required": [ "tenantDisplayName", "tenantIdentifier" ] }, "aws:appfabric/AppAuthorizationTimeouts:AppAuthorizationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:appfabric/IngestionDestinationDestinationConfiguration:IngestionDestinationDestinationConfiguration": { "properties": { "auditLog": { "$ref": "#/types/aws:appfabric/IngestionDestinationDestinationConfigurationAuditLog:IngestionDestinationDestinationConfigurationAuditLog", "description": "Contains information about an audit log processing configuration.\n" } }, "type": "object" }, "aws:appfabric/IngestionDestinationDestinationConfigurationAuditLog:IngestionDestinationDestinationConfigurationAuditLog": { "properties": { "destination": { "$ref": "#/types/aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestination:IngestionDestinationDestinationConfigurationAuditLogDestination", "description": "Contains information about an audit log destination. Only one destination (Firehose Stream) or (S3 Bucket) can be specified.\n" } }, "type": "object" }, "aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestination:IngestionDestinationDestinationConfigurationAuditLogDestination": { "properties": { "firehoseStream": { "$ref": "#/types/aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestinationFirehoseStream:IngestionDestinationDestinationConfigurationAuditLogDestinationFirehoseStream", "description": "Contains information about an Amazon Data Firehose delivery stream.\n" }, "s3Bucket": { "$ref": "#/types/aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestinationS3Bucket:IngestionDestinationDestinationConfigurationAuditLogDestinationS3Bucket", "description": "Contains information about an Amazon S3 bucket.\n" } }, "type": "object" }, "aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestinationFirehoseStream:IngestionDestinationDestinationConfigurationAuditLogDestinationFirehoseStream": { "properties": { "streamName": { "type": "string" } }, "type": "object", "required": [ "streamName" ] }, "aws:appfabric/IngestionDestinationDestinationConfigurationAuditLogDestinationS3Bucket:IngestionDestinationDestinationConfigurationAuditLogDestinationS3Bucket": { "properties": { "bucketName": { "type": "string" }, "prefix": { "type": "string", "description": "The object key to use.\n" } }, "type": "object", "required": [ "bucketName" ] }, "aws:appfabric/IngestionDestinationProcessingConfiguration:IngestionDestinationProcessingConfiguration": { "properties": { "auditLog": { "$ref": "#/types/aws:appfabric/IngestionDestinationProcessingConfigurationAuditLog:IngestionDestinationProcessingConfigurationAuditLog", "description": "Contains information about an audit log processing configuration.\n" } }, "type": "object" }, "aws:appfabric/IngestionDestinationProcessingConfigurationAuditLog:IngestionDestinationProcessingConfigurationAuditLog": { "properties": { "format": { "type": "string", "description": "The format in which the audit logs need to be formatted. Valid values: `json`, `parquet`.\n" }, "schema": { "type": "string", "description": "The event schema in which the audit logs need to be formatted. Valid values: `ocsf`, `raw`.\n" } }, "type": "object", "required": [ "format", "schema" ] }, "aws:appfabric/IngestionDestinationTimeouts:IngestionDestinationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfig:ConnectorProfileConnectorProfileConfig": { "properties": { "connectorProfileCredentials": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentials", "description": "The connector-specific credentials required by each connector. See Connector Profile Credentials for more details.\n" }, "connectorProfileProperties": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileProperties:ConnectorProfileConnectorProfileConfigConnectorProfileProperties", "description": "The connector-specific properties of the profile configuration. See Connector Profile Properties for more details.\n" } }, "type": "object", "required": [ "connectorProfileCredentials", "connectorProfileProperties" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentials": { "properties": { "amplitude": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsAmplitude:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsAmplitude", "description": "The connector-specific credentials required when using Amplitude. See Amplitude Connector Profile Credentials for more details.\n" }, "customConnector": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnector:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnector", "description": "The connector-specific profile credentials required when using the custom connector. See Custom Connector Profile Credentials for more details.\n" }, "datadog": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDatadog:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDatadog", "description": "Connector-specific credentials required when using Datadog. See Datadog Connector Profile Credentials for more details.\n" }, "dynatrace": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDynatrace:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDynatrace", "description": "The connector-specific credentials required when using Dynatrace. See Dynatrace Connector Profile Credentials for more details.\n" }, "googleAnalytics": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalytics:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalytics", "description": "The connector-specific credentials required when using Google Analytics. See Google Analytics Connector Profile Credentials for more details.\n" }, "honeycode": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycode:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycode", "description": "The connector-specific credentials required when using Amazon Honeycode. See Honeycode Connector Profile Credentials for more details.\n" }, "inforNexus": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsInforNexus:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsInforNexus", "description": "The connector-specific credentials required when using Infor Nexus. See Infor Nexus Connector Profile Credentials for more details.\n" }, "marketo": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketo:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketo", "description": "Connector-specific credentials required when using Marketo. See Marketo Connector Profile Credentials for more details.\n" }, "redshift": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsRedshift:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsRedshift", "description": "Connector-specific credentials required when using Amazon Redshift. See Redshift Connector Profile Credentials for more details.\n" }, "salesforce": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforce:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforce", "description": "The connector-specific credentials required when using Salesforce. See Salesforce Connector Profile Credentials for more details.\n" }, "sapoData": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoData:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoData", "description": "The connector-specific credentials required when using SAPOData. See SAPOData Connector Profile Credentials for more details.\n" }, "serviceNow": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsServiceNow:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsServiceNow", "description": "The connector-specific credentials required when using ServiceNow. See ServiceNow Connector Profile Credentials for more details.\n" }, "singular": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSingular:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSingular", "description": "Connector-specific credentials required when using Singular. See Singular Connector Profile Credentials for more details.\n" }, "slack": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlack:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlack", "description": "Connector-specific credentials required when using Slack. See Slack Connector Profile Credentials for more details.\n" }, "snowflake": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSnowflake:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSnowflake", "description": "The connector-specific credentials required when using Snowflake. See Snowflake Connector Profile Credentials for more details.\n" }, "trendmicro": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsTrendmicro:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsTrendmicro", "description": "The connector-specific credentials required when using Trend Micro. See Trend Micro Connector Profile Credentials for more details.\n" }, "veeva": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsVeeva:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsVeeva", "description": "Connector-specific credentials required when using Veeva. See Veeva Connector Profile Credentials for more details.\n" }, "zendesk": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendesk:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendesk", "description": "Connector-specific credentials required when using Zendesk. See Zendesk Connector Profile Credentials for more details.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsAmplitude:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsAmplitude": { "properties": { "apiKey": { "type": "string" }, "secretKey": { "type": "string", "description": "The Secret Access Key portion of the credentials.\n", "secret": true } }, "type": "object", "required": [ "apiKey", "secretKey" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnector:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnector": { "properties": { "apiKey": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorApiKey:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorApiKey" }, "authenticationType": { "type": "string", "description": "The authentication type that the custom connector uses for authenticating while creating a connector profile. One of: `APIKEY`, `BASIC`, `CUSTOM`, `OAUTH2`.\n" }, "basic": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorBasic:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorBasic", "description": "Basic credentials that are required for the authentication of the user.\n" }, "custom": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorCustom:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorCustom", "description": "If the connector uses the custom authentication mechanism, this holds the required credentials.\n" }, "oauth2": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2", "description": "OAuth 2.0 credentials required for the authentication of the user.\n" } }, "type": "object", "required": [ "authenticationType" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorApiKey:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorApiKey": { "properties": { "apiKey": { "type": "string" }, "apiSecretKey": { "type": "string" } }, "type": "object", "required": [ "apiKey" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorBasic:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorBasic": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorCustom:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorCustom": { "properties": { "credentialsMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that holds custom authentication credentials.\n", "secret": true }, "customAuthenticationType": { "type": "string", "description": "The custom authentication type that the connector uses.\n" } }, "type": "object", "required": [ "customAuthenticationType" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2OauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2OauthRequest" }, "refreshToken": { "type": "string" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2OauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsCustomConnectorOauth2OauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDatadog:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDatadog": { "properties": { "apiKey": { "type": "string" }, "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.\n" } }, "type": "object", "required": [ "apiKey", "applicationKey" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDynatrace:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsDynatrace": { "properties": { "apiToken": { "type": "string", "description": "The API tokens used by Dynatrace API to authenticate various API calls.\n" } }, "type": "object", "required": [ "apiToken" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalytics:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalytics": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalyticsOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalyticsOauthRequest" }, "refreshToken": { "type": "string" } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalyticsOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsGoogleAnalyticsOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycode:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycode": { "properties": { "accessToken": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycodeOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycodeOauthRequest" }, "refreshToken": { "type": "string" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycodeOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsHoneycodeOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsInforNexus:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsInforNexus": { "properties": { "accessKeyId": { "type": "string", "description": "The Access Key portion of the credentials.\n" }, "datakey": { "type": "string", "description": "Encryption keys used to encrypt data.\n" }, "secretAccessKey": { "type": "string", "description": "The secret key used to sign requests.\n", "secret": true }, "userId": { "type": "string", "description": "Identifier for the user.\n" } }, "type": "object", "required": [ "accessKeyId", "datakey", "secretAccessKey", "userId" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketo:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketo": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketoOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketoOauthRequest" } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketoOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsMarketoOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsRedshift:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsRedshift": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforce:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforce": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientCredentialsArn": { "type": "string", "description": "The secret manager ARN, which contains the client ID and client secret of the connected app.\n" }, "jwtToken": { "type": "string", "description": "A JSON web token (JWT) that authorizes access to Salesforce records.\n" }, "oauth2GrantType": { "type": "string" }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforceOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforceOauthRequest" }, "refreshToken": { "type": "string" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforceOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSalesforceOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoData:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoData": { "properties": { "basicAuthCredentials": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataBasicAuthCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataBasicAuthCredentials", "description": "The SAPOData basic authentication credentials.\n" }, "oauthCredentials": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentials", "description": "The SAPOData OAuth type authentication credentials.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataBasicAuthCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataBasicAuthCredentials": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentials:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentials": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentialsOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentialsOauthRequest" }, "refreshToken": { "type": "string" } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentialsOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSapoDataOauthCredentialsOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsServiceNow:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsServiceNow": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSingular:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSingular": { "properties": { "apiKey": { "type": "string" } }, "type": "object", "required": [ "apiKey" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlack:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlack": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlackOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlackOauthRequest" } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlackOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSlackOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSnowflake:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsSnowflake": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsTrendmicro:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsTrendmicro": { "properties": { "apiSecretKey": { "type": "string", "secret": true } }, "type": "object", "required": [ "apiSecretKey" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsVeeva:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsVeeva": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendesk:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendesk": { "properties": { "accessToken": { "type": "string", "secret": true }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "oauthRequest": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendeskOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendeskOauthRequest" } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendeskOauthRequest:ConnectorProfileConnectorProfileConfigConnectorProfileCredentialsZendeskOauthRequest": { "properties": { "authCode": { "type": "string", "description": "The code provided by the connector when it has been authenticated via the connected app.\n" }, "redirectUri": { "type": "string", "description": "The URL to which the authentication server redirects the browser after authorization has been granted.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfileProperties:ConnectorProfileConnectorProfileConfigConnectorProfileProperties": { "properties": { "amplitude": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesAmplitude:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesAmplitude", "description": "The connector-specific credentials required when using Amplitude. See Amplitude Connector Profile Credentials for more details.\n" }, "customConnector": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnector:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnector", "description": "The connector-specific profile properties required when using the custom connector. See Custom Connector Profile Properties for more details.\n" }, "datadog": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDatadog:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDatadog", "description": "Connector-specific properties required when using Datadog. See Generic Connector Profile Properties for more details.\n" }, "dynatrace": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDynatrace:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDynatrace", "description": "The connector-specific properties required when using Dynatrace. See Generic Connector Profile Properties for more details.\n" }, "googleAnalytics": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesGoogleAnalytics:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesGoogleAnalytics", "description": "The connector-specific credentials required when using Google Analytics. See Google Analytics Connector Profile Credentials for more details.\n" }, "honeycode": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesHoneycode:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesHoneycode", "description": "The connector-specific credentials required when using Amazon Honeycode. See Honeycode Connector Profile Credentials for more details.\n" }, "inforNexus": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesInforNexus:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesInforNexus", "description": "The connector-specific properties required when using Infor Nexus. See Generic Connector Profile Properties for more details.\n" }, "marketo": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesMarketo:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesMarketo", "description": "Connector-specific properties required when using Marketo. See Generic Connector Profile Properties for more details.\n" }, "redshift": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesRedshift:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesRedshift", "description": "Connector-specific properties required when using Amazon Redshift. See Redshift Connector Profile Properties for more details.\n" }, "salesforce": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSalesforce:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSalesforce", "description": "The connector-specific properties required when using Salesforce. See Salesforce Connector Profile Properties for more details.\n" }, "sapoData": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoData:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoData", "description": "The connector-specific properties required when using SAPOData. See SAPOData Connector Profile Properties for more details.\n" }, "serviceNow": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesServiceNow:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesServiceNow", "description": "The connector-specific properties required when using ServiceNow. See Generic Connector Profile Properties for more details.\n" }, "singular": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSingular:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSingular", "description": "Connector-specific credentials required when using Singular. See Singular Connector Profile Credentials for more details.\n" }, "slack": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSlack:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSlack", "description": "Connector-specific properties required when using Slack. See Generic Connector Profile Properties for more details.\n" }, "snowflake": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSnowflake:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSnowflake", "description": "The connector-specific properties required when using Snowflake. See Snowflake Connector Profile Properties for more details.\n" }, "trendmicro": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesTrendmicro:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesTrendmicro", "description": "The connector-specific credentials required when using Trend Micro. See Trend Micro Connector Profile Credentials for more details.\n" }, "veeva": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesVeeva:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesVeeva", "description": "Connector-specific properties required when using Veeva. See Generic Connector Profile Properties for more details.\n" }, "zendesk": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesZendesk:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesZendesk", "description": "Connector-specific properties required when using Zendesk. See Generic Connector Profile Properties for more details.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesAmplitude:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesAmplitude": { "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnector:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnector": { "properties": { "oauth2Properties": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnectorOauth2Properties:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnectorOauth2Properties", "description": "The OAuth 2.0 properties required for OAuth 2.0 authentication.\n" }, "profileProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of properties that are required to create a profile for the custom connector.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnectorOauth2Properties:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesCustomConnectorOauth2Properties": { "properties": { "oauth2GrantType": { "type": "string" }, "tokenUrl": { "type": "string" }, "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.\n" } }, "type": "object", "required": [ "oauth2GrantType", "tokenUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDatadog:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDatadog": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDynatrace:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesDynatrace": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesGoogleAnalytics:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesGoogleAnalytics": { "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesHoneycode:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesHoneycode": { "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesInforNexus:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesInforNexus": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesMarketo:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesMarketo": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesRedshift:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesRedshift": { "properties": { "bucketName": { "type": "string" }, "bucketPrefix": { "type": "string" }, "clusterIdentifier": { "type": "string", "description": "The unique ID that's assigned to an Amazon Redshift cluster.\n" }, "dataApiRoleArn": { "type": "string", "description": "ARN of the IAM role that permits AppFlow to access the database through Data API.\n" }, "databaseName": { "type": "string", "description": "The name of an Amazon Redshift database.\n" }, "databaseUrl": { "type": "string", "description": "The JDBC URL of the Amazon Redshift cluster.\n" }, "roleArn": { "type": "string", "description": "ARN of the IAM role.\n" } }, "type": "object", "required": [ "bucketName", "roleArn" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSalesforce:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSalesforce": { "properties": { "instanceUrl": { "type": "string" }, "isSandboxEnvironment": { "type": "boolean", "description": "Indicates whether the connector profile applies to a sandbox or production environment.\n" }, "usePrivatelinkForMetadataAndAuthorization": { "type": "boolean", "description": "Indicates whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through AWS PrivateLink. These calls travel through AWS infrastructure without being exposed to the public internet.\n" } }, "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoData:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoData": { "properties": { "applicationHostUrl": { "type": "string", "description": "The location of the SAPOData resource.\n" }, "applicationServicePath": { "type": "string", "description": "The application path to catalog service.\n" }, "clientNumber": { "type": "string", "description": "The client number for the client creating the connection.\n" }, "logonLanguage": { "type": "string", "description": "The logon language of SAPOData instance.\n" }, "oauthProperties": { "$ref": "#/types/aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoDataOauthProperties:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoDataOauthProperties", "description": "The SAPOData OAuth properties required for OAuth type authentication.\n" }, "portNumber": { "type": "integer", "description": "The port number of the SAPOData instance.\n" }, "privateLinkServiceName": { "type": "string" } }, "type": "object", "required": [ "applicationHostUrl", "applicationServicePath", "clientNumber", "portNumber" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoDataOauthProperties:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSapoDataOauthProperties": { "properties": { "authCodeUrl": { "type": "string", "description": "The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.\n" }, "oauthScopes": { "type": "array", "items": { "type": "string" }, "description": "The OAuth scopes required for OAuth type authentication.\n" }, "tokenUrl": { "type": "string" } }, "type": "object", "required": [ "authCodeUrl", "oauthScopes", "tokenUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesServiceNow:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesServiceNow": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSingular:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSingular": { "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSlack:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSlack": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSnowflake:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesSnowflake": { "properties": { "accountName": { "type": "string", "description": "The name of the account.\n" }, "bucketName": { "type": "string" }, "bucketPrefix": { "type": "string" }, "privateLinkServiceName": { "type": "string" }, "region": { "type": "string", "description": "AWS Region of the Snowflake account.\n" }, "stage": { "type": "string", "description": "Name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: `\u003cDatabase\u003e.\u003cSchema\u003e.\u003cStage Name\u003e`.\n" }, "warehouse": { "type": "string", "description": "The name of the Snowflake warehouse.\n" } }, "type": "object", "required": [ "bucketName", "stage", "warehouse" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesTrendmicro:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesTrendmicro": { "type": "object" }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesVeeva:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesVeeva": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesZendesk:ConnectorProfileConnectorProfileConfigConnectorProfilePropertiesZendesk": { "properties": { "instanceUrl": { "type": "string" } }, "type": "object", "required": [ "instanceUrl" ] }, "aws:appflow/FlowDestinationFlowConfig:FlowDestinationFlowConfig": { "properties": { "apiVersion": { "type": "string", "description": "API version that the destination connector uses.\n" }, "connectorProfileName": { "type": "string", "description": "Name of the connector profile. This name must be unique for each connector profile in the AWS account.\n" }, "connectorType": { "type": "string", "description": "Type of connector, such as Salesforce, Amplitude, and so on. Valid values are `Salesforce`, `Singular`, `Slack`, `Redshift`, `S3`, `Marketo`, `Googleanalytics`, `Zendesk`, `Servicenow`, `Datadog`, `Trendmicro`, `Snowflake`, `Dynatrace`, `Infornexus`, `Amplitude`, `Veeva`, `EventBridge`, `LookoutMetrics`, `Upsolver`, `Honeycode`, `CustomerProfiles`, `SAPOData`, and `CustomConnector`.\n" }, "destinationConnectorProperties": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorProperties:FlowDestinationFlowConfigDestinationConnectorProperties", "description": "This stores the information that is required to query a particular connector. See Destination Connector Properties for more information.\n" } }, "type": "object", "required": [ "connectorType", "destinationConnectorProperties" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorProperties:FlowDestinationFlowConfigDestinationConnectorProperties": { "properties": { "customConnector": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnector:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnector", "description": "Properties that are required to query the custom Connector. See Custom Connector Destination Properties for more details.\n" }, "customerProfiles": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomerProfiles:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomerProfiles", "description": "Properties that are required to query Amazon Connect Customer Profiles. See Customer Profiles Destination Properties for more details.\n" }, "eventBridge": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridge:FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridge", "description": "Properties that are required to query Amazon EventBridge. See Generic Destination Properties for more details.\n" }, "honeycode": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycode:FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycode", "description": "Properties that are required to query Amazon Honeycode. See Generic Destination Properties for more details.\n" }, "lookoutMetrics": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesLookoutMetrics:FlowDestinationFlowConfigDestinationConnectorPropertiesLookoutMetrics" }, "marketo": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesMarketo:FlowDestinationFlowConfigDestinationConnectorPropertiesMarketo", "description": "Properties that are required to query Marketo. See Generic Destination Properties for more details.\n" }, "redshift": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesRedshift:FlowDestinationFlowConfigDestinationConnectorPropertiesRedshift", "description": "Properties that are required to query Amazon Redshift. See Redshift Destination Properties for more details.\n" }, "s3": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3:FlowDestinationFlowConfigDestinationConnectorPropertiesS3", "description": "Properties that are required to query Amazon S3. See S3 Destination Properties for more details.\n" }, "salesforce": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforce:FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforce", "description": "Properties that are required to query Salesforce. See Salesforce Destination Properties for more details.\n" }, "sapoData": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoData:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoData", "description": "Properties that are required to query SAPOData. See SAPOData Destination Properties for more details.\n" }, "snowflake": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflake:FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflake", "description": "Properties that are required to query Snowflake. See Snowflake Destination Properties for more details.\n" }, "upsolver": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolver:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolver", "description": "Properties that are required to query Upsolver. See Upsolver Destination Properties for more details.\n" }, "zendesk": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesZendesk:FlowDestinationFlowConfigDestinationConnectorPropertiesZendesk", "description": "Properties that are required to query Zendesk. See Zendesk Destination Properties for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "s3" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnector:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnector": { "properties": { "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "entityName": { "type": "string" }, "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnectorErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnectorErrorHandlingConfig" }, "idFieldNames": { "type": "array", "items": { "type": "string" } }, "writeOperationType": { "type": "string" } }, "type": "object", "required": [ "entityName" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnectorErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomConnectorErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesCustomerProfiles:FlowDestinationFlowConfigDestinationConnectorPropertiesCustomerProfiles": { "properties": { "domainName": { "type": "string", "description": "Unique name of the Amazon Connect Customer Profiles domain.\n" }, "objectTypeName": { "type": "string", "description": "Object specified in the Amazon Connect Customer Profiles flow destination.\n" } }, "type": "object", "required": [ "domainName" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridge:FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridge": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridgeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridgeErrorHandlingConfig" }, "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridgeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesEventBridgeErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycode:FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycode": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycodeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycodeErrorHandlingConfig" }, "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycodeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesHoneycodeErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesLookoutMetrics:FlowDestinationFlowConfigDestinationConnectorPropertiesLookoutMetrics": { "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesMarketo:FlowDestinationFlowConfigDestinationConnectorPropertiesMarketo": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesMarketoErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesMarketoErrorHandlingConfig" }, "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesMarketoErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesMarketoErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesRedshift:FlowDestinationFlowConfigDestinationConnectorPropertiesRedshift": { "properties": { "bucketPrefix": { "type": "string" }, "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesRedshiftErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesRedshiftErrorHandlingConfig" }, "intermediateBucketName": { "type": "string" }, "object": { "type": "string" } }, "type": "object", "required": [ "intermediateBucketName", "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesRedshiftErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesRedshiftErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3:FlowDestinationFlowConfigDestinationConnectorPropertiesS3": { "properties": { "bucketName": { "type": "string" }, "bucketPrefix": { "type": "string" }, "s3OutputFormatConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfig" } }, "type": "object", "required": [ "bucketName" ], "language": { "nodejs": { "requiredOutputs": [ "bucketName", "bucketPrefix", "s3OutputFormatConfig" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfig": { "properties": { "aggregationConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigAggregationConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigAggregationConfig", "description": "Aggregation settings that you can use to customize the output format of your flow data. See Aggregation Config for more details.\n" }, "fileType": { "type": "string", "description": "File type that Amazon AppFlow places in the Amazon S3 bucket. Valid values are `CSV`, `JSON`, and `PARQUET`.\n" }, "prefixConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigPrefixConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigPrefixConfig", "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. See Prefix Config for more details.\n" }, "preserveSourceDataTyping": { "type": "boolean", "description": "Whether the data types from the source system need to be preserved (Only valid for `Parquet` file type)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aggregationConfig", "prefixConfig", "preserveSourceDataTyping" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigAggregationConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigAggregationConfig": { "properties": { "aggregationType": { "type": "string", "description": "Whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated. Valid values are `None` and `SingleFile`.\n" }, "targetFileSize": { "type": "integer", "description": "The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. Integer value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aggregationType", "targetFileSize" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigPrefixConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesS3S3OutputFormatConfigPrefixConfig": { "properties": { "prefixFormat": { "type": "string", "description": "Determines the level of granularity that's included in the prefix. Valid values are `YEAR`, `MONTH`, `DAY`, `HOUR`, and `MINUTE`.\n" }, "prefixHierarchies": { "type": "array", "items": { "type": "string" }, "description": "Determines whether the destination file path includes either or both of the selected elements. Valid values are `EXECUTION_ID` and `SCHEMA_VERSION`\n" }, "prefixType": { "type": "string", "description": "Determines the format of the prefix, and whether it applies to the file name, file path, or both. Valid values are `FILENAME`, `PATH`, and `PATH_AND_FILENAME`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "prefixHierarchies" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforce:FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforce": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforceErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforceErrorHandlingConfig" }, "idFieldNames": { "type": "array", "items": { "type": "string" } }, "object": { "type": "string" }, "writeOperationType": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforceErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSalesforceErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoData:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoData": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataErrorHandlingConfig" }, "idFieldNames": { "type": "array", "items": { "type": "string" } }, "objectPath": { "type": "string" }, "successResponseHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataSuccessResponseHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataSuccessResponseHandlingConfig", "description": "Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. See Success Response Handling Config for more details.\n" }, "writeOperationType": { "type": "string" } }, "type": "object", "required": [ "objectPath" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataSuccessResponseHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSapoDataSuccessResponseHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflake:FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflake": { "properties": { "bucketPrefix": { "type": "string" }, "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflakeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflakeErrorHandlingConfig" }, "intermediateBucketName": { "type": "string" }, "object": { "type": "string" } }, "type": "object", "required": [ "intermediateBucketName", "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflakeErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesSnowflakeErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolver:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolver": { "properties": { "bucketName": { "type": "string" }, "bucketPrefix": { "type": "string" }, "s3OutputFormatConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfig" } }, "type": "object", "required": [ "bucketName", "s3OutputFormatConfig" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfig": { "properties": { "aggregationConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigAggregationConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigAggregationConfig", "description": "Aggregation settings that you can use to customize the output format of your flow data. See Aggregation Config for more details.\n" }, "fileType": { "type": "string", "description": "File type that Amazon AppFlow places in the Amazon S3 bucket. Valid values are `CSV`, `JSON`, and `PARQUET`.\n" }, "prefixConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigPrefixConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigPrefixConfig", "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. See Prefix Config for more details.\n" } }, "type": "object", "required": [ "prefixConfig" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigAggregationConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigAggregationConfig": { "properties": { "aggregationType": { "type": "string", "description": "Whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated. Valid values are `None` and `SingleFile`.\n" } }, "type": "object" }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigPrefixConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesUpsolverS3OutputFormatConfigPrefixConfig": { "properties": { "prefixFormat": { "type": "string", "description": "Determines the level of granularity that's included in the prefix. Valid values are `YEAR`, `MONTH`, `DAY`, `HOUR`, and `MINUTE`.\n" }, "prefixHierarchies": { "type": "array", "items": { "type": "string" }, "description": "Determines whether the destination file path includes either or both of the selected elements. Valid values are `EXECUTION_ID` and `SCHEMA_VERSION`\n" }, "prefixType": { "type": "string", "description": "Determines the format of the prefix, and whether it applies to the file name, file path, or both. Valid values are `FILENAME`, `PATH`, and `PATH_AND_FILENAME`.\n" } }, "type": "object", "required": [ "prefixType" ], "language": { "nodejs": { "requiredOutputs": [ "prefixHierarchies", "prefixType" ] } } }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesZendesk:FlowDestinationFlowConfigDestinationConnectorPropertiesZendesk": { "properties": { "errorHandlingConfig": { "$ref": "#/types/aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesZendeskErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesZendeskErrorHandlingConfig" }, "idFieldNames": { "type": "array", "items": { "type": "string" } }, "object": { "type": "string" }, "writeOperationType": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowDestinationFlowConfigDestinationConnectorPropertiesZendeskErrorHandlingConfig:FlowDestinationFlowConfigDestinationConnectorPropertiesZendeskErrorHandlingConfig": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket.\n" }, "bucketPrefix": { "type": "string", "description": "Amazon S3 bucket prefix.\n" }, "failOnFirstDestinationError": { "type": "boolean", "description": "If the flow should fail after the first instance of a failure when attempting to place data in the destination.\n" } }, "type": "object" }, "aws:appflow/FlowMetadataCatalogConfig:FlowMetadataCatalogConfig": { "properties": { "glueDataCatalog": { "$ref": "#/types/aws:appflow/FlowMetadataCatalogConfigGlueDataCatalog:FlowMetadataCatalogConfigGlueDataCatalog" } }, "type": "object" }, "aws:appflow/FlowMetadataCatalogConfigGlueDataCatalog:FlowMetadataCatalogConfigGlueDataCatalog": { "properties": { "databaseName": { "type": "string", "description": "The name of an existing Glue database to store the metadata tables that Amazon AppFlow creates.\n" }, "roleArn": { "type": "string", "description": "The ARN of an IAM role that grants AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.\n" }, "tablePrefix": { "type": "string", "description": "A naming prefix for each Data Catalog table that Amazon AppFlow creates\n" } }, "type": "object", "required": [ "databaseName", "roleArn", "tablePrefix" ] }, "aws:appflow/FlowSourceFlowConfig:FlowSourceFlowConfig": { "properties": { "apiVersion": { "type": "string", "description": "API version that the destination connector uses.\n" }, "connectorProfileName": { "type": "string", "description": "Name of the connector profile. This name must be unique for each connector profile in the AWS account.\n" }, "connectorType": { "type": "string", "description": "Type of connector, such as Salesforce, Amplitude, and so on. Valid values are `Salesforce`, `Singular`, `Slack`, `Redshift`, `S3`, `Marketo`, `Googleanalytics`, `Zendesk`, `Servicenow`, `Datadog`, `Trendmicro`, `Snowflake`, `Dynatrace`, `Infornexus`, `Amplitude`, `Veeva`, `EventBridge`, `LookoutMetrics`, `Upsolver`, `Honeycode`, `CustomerProfiles`, `SAPOData`, and `CustomConnector`.\n" }, "incrementalPullConfig": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigIncrementalPullConfig:FlowSourceFlowConfigIncrementalPullConfig", "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. See Incremental Pull Config for more details.\n" }, "sourceConnectorProperties": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorProperties:FlowSourceFlowConfigSourceConnectorProperties", "description": "Information that is required to query a particular source connector. See Source Connector Properties for details.\n" } }, "type": "object", "required": [ "connectorType", "sourceConnectorProperties" ] }, "aws:appflow/FlowSourceFlowConfigIncrementalPullConfig:FlowSourceFlowConfigIncrementalPullConfig": { "properties": { "datetimeTypeFieldName": { "type": "string", "description": "Field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.\n" } }, "type": "object" }, "aws:appflow/FlowSourceFlowConfigSourceConnectorProperties:FlowSourceFlowConfigSourceConnectorProperties": { "properties": { "amplitude": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesAmplitude:FlowSourceFlowConfigSourceConnectorPropertiesAmplitude", "description": "Information that is required for querying Amplitude. See Generic Source Properties for more details.\n" }, "customConnector": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesCustomConnector:FlowSourceFlowConfigSourceConnectorPropertiesCustomConnector", "description": "Properties that are applied when the custom connector is being used as a source. See Custom Connector Source Properties.\n" }, "datadog": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesDatadog:FlowSourceFlowConfigSourceConnectorPropertiesDatadog", "description": "Information that is required for querying Datadog. See Generic Source Properties for more details.\n" }, "dynatrace": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesDynatrace:FlowSourceFlowConfigSourceConnectorPropertiesDynatrace", "description": "Operation to be performed on the provided Dynatrace source fields. Valid values are `PROJECTION`, `BETWEEN`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "googleAnalytics": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesGoogleAnalytics:FlowSourceFlowConfigSourceConnectorPropertiesGoogleAnalytics", "description": "Operation to be performed on the provided Google Analytics source fields. Valid values are `PROJECTION` and `BETWEEN`.\n" }, "inforNexus": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesInforNexus:FlowSourceFlowConfigSourceConnectorPropertiesInforNexus", "description": "Information that is required for querying Infor Nexus. See Generic Source Properties for more details.\n" }, "marketo": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesMarketo:FlowSourceFlowConfigSourceConnectorPropertiesMarketo", "description": "Information that is required for querying Marketo. See Generic Source Properties for more details.\n" }, "s3": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesS3:FlowSourceFlowConfigSourceConnectorPropertiesS3", "description": "Information that is required for querying Amazon S3. See S3 Source Properties for more details.\n" }, "salesforce": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSalesforce:FlowSourceFlowConfigSourceConnectorPropertiesSalesforce", "description": "Information that is required for querying Salesforce. See Salesforce Source Properties for more details.\n" }, "sapoData": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoData:FlowSourceFlowConfigSourceConnectorPropertiesSapoData", "description": "Information that is required for querying SAPOData as a flow source. See SAPO Source Properties for more details.\n" }, "serviceNow": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesServiceNow:FlowSourceFlowConfigSourceConnectorPropertiesServiceNow", "description": "Information that is required for querying ServiceNow. See Generic Source Properties for more details.\n" }, "singular": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSingular:FlowSourceFlowConfigSourceConnectorPropertiesSingular", "description": "Information that is required for querying Singular. See Generic Source Properties for more details.\n" }, "slack": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSlack:FlowSourceFlowConfigSourceConnectorPropertiesSlack", "description": "Information that is required for querying Slack. See Generic Source Properties for more details.\n" }, "trendmicro": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesTrendmicro:FlowSourceFlowConfigSourceConnectorPropertiesTrendmicro", "description": "Operation to be performed on the provided Trend Micro source fields. Valid values are `PROJECTION`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "veeva": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesVeeva:FlowSourceFlowConfigSourceConnectorPropertiesVeeva", "description": "Information that is required for querying Veeva. See Veeva Source Properties for more details.\n" }, "zendesk": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesZendesk:FlowSourceFlowConfigSourceConnectorPropertiesZendesk", "description": "Information that is required for querying Zendesk. See Generic Source Properties for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "s3" ] } } }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesAmplitude:FlowSourceFlowConfigSourceConnectorPropertiesAmplitude": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesCustomConnector:FlowSourceFlowConfigSourceConnectorPropertiesCustomConnector": { "properties": { "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "entityName": { "type": "string" } }, "type": "object", "required": [ "entityName" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesDatadog:FlowSourceFlowConfigSourceConnectorPropertiesDatadog": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesDynatrace:FlowSourceFlowConfigSourceConnectorPropertiesDynatrace": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesGoogleAnalytics:FlowSourceFlowConfigSourceConnectorPropertiesGoogleAnalytics": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesInforNexus:FlowSourceFlowConfigSourceConnectorPropertiesInforNexus": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesMarketo:FlowSourceFlowConfigSourceConnectorPropertiesMarketo": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesS3:FlowSourceFlowConfigSourceConnectorPropertiesS3": { "properties": { "bucketName": { "type": "string", "willReplaceOnChanges": true }, "bucketPrefix": { "type": "string", "willReplaceOnChanges": true }, "s3InputFormatConfig": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesS3S3InputFormatConfig:FlowSourceFlowConfigSourceConnectorPropertiesS3S3InputFormatConfig", "description": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data. See S3 Input Format Config for details.\n" } }, "type": "object", "required": [ "bucketName", "bucketPrefix" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesS3S3InputFormatConfig:FlowSourceFlowConfigSourceConnectorPropertiesS3S3InputFormatConfig": { "properties": { "s3InputFileType": { "type": "string", "description": "File type that Amazon AppFlow gets from your Amazon S3 bucket. Valid values are `CSV` and `JSON`.\n" } }, "type": "object" }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSalesforce:FlowSourceFlowConfigSourceConnectorPropertiesSalesforce": { "properties": { "dataTransferApi": { "type": "string", "description": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.\n" }, "enableDynamicFieldUpdate": { "type": "boolean", "description": "Flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.\n" }, "includeDeletedRecords": { "type": "boolean", "description": "Whether Amazon AppFlow includes deleted files in the flow run.\n" }, "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoData:FlowSourceFlowConfigSourceConnectorPropertiesSapoData": { "properties": { "objectPath": { "type": "string" }, "paginationConfig": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoDataPaginationConfig:FlowSourceFlowConfigSourceConnectorPropertiesSapoDataPaginationConfig", "description": "Sets the page size for each concurrent process that transfers OData records from your SAP instance.\n" }, "parallelismConfig": { "$ref": "#/types/aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoDataParallelismConfig:FlowSourceFlowConfigSourceConnectorPropertiesSapoDataParallelismConfig", "description": "Sets the number of concurrent processes that transfers OData records from your SAP instance.\n" } }, "type": "object", "required": [ "objectPath" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoDataPaginationConfig:FlowSourceFlowConfigSourceConnectorPropertiesSapoDataPaginationConfig": { "properties": { "maxPageSize": { "type": "integer", "description": "he maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application.\n" } }, "type": "object", "required": [ "maxPageSize" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSapoDataParallelismConfig:FlowSourceFlowConfigSourceConnectorPropertiesSapoDataParallelismConfig": { "properties": { "maxPageSize": { "type": "integer", "description": "he maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application.\n" } }, "type": "object", "required": [ "maxPageSize" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesServiceNow:FlowSourceFlowConfigSourceConnectorPropertiesServiceNow": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSingular:FlowSourceFlowConfigSourceConnectorPropertiesSingular": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesSlack:FlowSourceFlowConfigSourceConnectorPropertiesSlack": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesTrendmicro:FlowSourceFlowConfigSourceConnectorPropertiesTrendmicro": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesVeeva:FlowSourceFlowConfigSourceConnectorPropertiesVeeva": { "properties": { "documentType": { "type": "string", "description": "Document type specified in the Veeva document extract flow.\n" }, "includeAllVersions": { "type": "boolean", "description": "Boolean value to include All Versions of files in Veeva document extract flow.\n" }, "includeRenditions": { "type": "boolean", "description": "Boolean value to include file renditions in Veeva document extract flow.\n" }, "includeSourceFiles": { "type": "boolean", "description": "Boolean value to include source files in Veeva document extract flow.\n" }, "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowSourceFlowConfigSourceConnectorPropertiesZendesk:FlowSourceFlowConfigSourceConnectorPropertiesZendesk": { "properties": { "object": { "type": "string" } }, "type": "object", "required": [ "object" ] }, "aws:appflow/FlowTask:FlowTask": { "properties": { "connectorOperators": { "type": "array", "items": { "$ref": "#/types/aws:appflow/FlowTaskConnectorOperator:FlowTaskConnectorOperator" }, "description": "Operation to be performed on the provided source fields. See Connector Operator for details.\n" }, "destinationField": { "type": "string", "description": "Field in a destination connector, or a field value against which Amazon AppFlow validates a source field.\n" }, "sourceFields": { "type": "array", "items": { "type": "string" }, "description": "Source fields to which a particular task is applied.\n" }, "taskProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map used to store task-related information. The execution service looks for particular information based on the `TaskType`. Valid keys are `VALUE`, `VALUES`, `DATA_TYPE`, `UPPER_BOUND`, `LOWER_BOUND`, `SOURCE_DATA_TYPE`, `DESTINATION_DATA_TYPE`, `VALIDATION_ACTION`, `MASK_VALUE`, `MASK_LENGTH`, `TRUNCATE_LENGTH`, `MATH_OPERATION_FIELDS_ORDER`, `CONCAT_FORMAT`, `SUBFIELD_CATEGORY_MAP`, and `EXCLUDE_SOURCE_FIELDS_LIST`.\n" }, "taskType": { "type": "string", "description": "Particular task implementation that Amazon AppFlow performs. Valid values are `Arithmetic`, `Filter`, `Map`, `Map_all`, `Mask`, `Merge`, `Passthrough`, `Truncate`, and `Validate`.\n" } }, "type": "object", "required": [ "taskType" ], "language": { "nodejs": { "requiredOutputs": [ "sourceFields", "taskType" ] } } }, "aws:appflow/FlowTaskConnectorOperator:FlowTaskConnectorOperator": { "properties": { "amplitude": { "type": "string", "description": "Operation to be performed on the provided Amplitude source fields. The only valid value is `BETWEEN`.\n" }, "customConnector": { "type": "string", "description": "Operators supported by the custom connector. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `CONTAINS`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "datadog": { "type": "string", "description": "Operation to be performed on the provided Datadog source fields. Valid values are `PROJECTION`, `BETWEEN`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "dynatrace": { "type": "string", "description": "Operation to be performed on the provided Dynatrace source fields. Valid values are `PROJECTION`, `BETWEEN`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "googleAnalytics": { "type": "string", "description": "Operation to be performed on the provided Google Analytics source fields. Valid values are `PROJECTION` and `BETWEEN`.\n" }, "inforNexus": { "type": "string", "description": "Operation to be performed on the provided Infor Nexus source fields. Valid values are `PROJECTION`, `BETWEEN`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "marketo": { "type": "string", "description": "Operation to be performed on the provided Marketo source fields. Valid values are `PROJECTION`, `BETWEEN`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "s3": { "type": "string", "description": "Operation to be performed on the provided Amazon S3 source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "salesforce": { "type": "string", "description": "Operation to be performed on the provided Salesforce source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `CONTAINS`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "sapoData": { "type": "string", "description": "Operation to be performed on the provided SAPOData source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `CONTAINS`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "serviceNow": { "type": "string", "description": "Operation to be performed on the provided ServiceNow source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `CONTAINS`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "singular": { "type": "string", "description": "Operation to be performed on the provided Singular source fields. Valid values are `PROJECTION`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "slack": { "type": "string", "description": "Operation to be performed on the provided Slack source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "trendmicro": { "type": "string", "description": "Operation to be performed on the provided Trend Micro source fields. Valid values are `PROJECTION`, `EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "veeva": { "type": "string", "description": "Operation to be performed on the provided Veeva source fields. Valid values are `PROJECTION`, `LESS_THAN`, `GREATER_THAN`, `CONTAINS`, `BETWEEN`, `LESS_THAN_OR_EQUAL_TO`, `GREATER_THAN_OR_EQUAL_TO`, `EQUAL_TO`, `NOT_EQUAL_TO`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" }, "zendesk": { "type": "string", "description": "Operation to be performed on the provided Zendesk source fields. Valid values are `PROJECTION`, `GREATER_THAN`, `ADDITION`, `MULTIPLICATION`, `DIVISION`, `SUBTRACTION`, `MASK_ALL`, `MASK_FIRST_N`, `MASK_LAST_N`, `VALIDATE_NON_NULL`, `VALIDATE_NON_ZERO`, `VALIDATE_NON_NEGATIVE`, `VALIDATE_NUMERIC`, and `NO_OP`.\n" } }, "type": "object" }, "aws:appflow/FlowTriggerConfig:FlowTriggerConfig": { "properties": { "triggerProperties": { "$ref": "#/types/aws:appflow/FlowTriggerConfigTriggerProperties:FlowTriggerConfigTriggerProperties", "description": "Configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the `Scheduled` trigger type. See Scheduled Trigger Properties for details.\n" }, "triggerType": { "type": "string", "description": "Type of flow trigger. Valid values are `Scheduled`, `Event`, and `OnDemand`.\n" } }, "type": "object", "required": [ "triggerType" ], "language": { "nodejs": { "requiredOutputs": [ "triggerProperties", "triggerType" ] } } }, "aws:appflow/FlowTriggerConfigTriggerProperties:FlowTriggerConfigTriggerProperties": { "properties": { "scheduled": { "$ref": "#/types/aws:appflow/FlowTriggerConfigTriggerPropertiesScheduled:FlowTriggerConfigTriggerPropertiesScheduled" } }, "type": "object" }, "aws:appflow/FlowTriggerConfigTriggerPropertiesScheduled:FlowTriggerConfigTriggerPropertiesScheduled": { "properties": { "dataPullMode": { "type": "string", "description": "Whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. Valid values are `Incremental` and `Complete`.\n" }, "firstExecutionFrom": { "type": "string", "description": "Date range for the records to import from the connector in the first flow run. Must be a valid RFC3339 timestamp.\n" }, "scheduleEndTime": { "type": "string", "description": "Scheduled end time for a schedule-triggered flow. Must be a valid RFC3339 timestamp.\n" }, "scheduleExpression": { "type": "string", "description": "Scheduling expression that determines the rate at which the schedule will run, for example `rate(5minutes)`.\n" }, "scheduleOffset": { "type": "integer", "description": "Optional offset that is added to the time interval for a schedule-triggered flow. Maximum value of 36000.\n" }, "scheduleStartTime": { "type": "string", "description": "Scheduled start time for a schedule-triggered flow. Must be a valid RFC3339 timestamp.\n" }, "timezone": { "type": "string", "description": "Time zone used when referring to the date and time of a scheduled-triggered flow, such as `America/New_York`.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n example:\n type: aws:appflow:Flow\n properties:\n triggerConfig:\n scheduled:\n - scheduleExpression: rate(1minutes)\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" } }, "type": "object", "required": [ "scheduleExpression" ] }, "aws:appintegrations/DataIntegrationScheduleConfig:DataIntegrationScheduleConfig": { "properties": { "firstExecutionFrom": { "type": "string", "description": "The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The name of the object to pull from the data source. Examples of objects in Salesforce include `Case`, `Account`, or `Lead`.\n", "willReplaceOnChanges": true }, "scheduleExpression": { "type": "string", "description": "How often the data should be pulled from data source. Examples include `rate(1 hour)`, `rate(3 hours)`, `rate(1 day)`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "firstExecutionFrom", "object", "scheduleExpression" ] }, "aws:appintegrations/getEventIntegrationEventFilter:getEventIntegrationEventFilter": { "properties": { "source": { "type": "string", "description": "The source of the events.\n" } }, "type": "object", "required": [ "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:applicationloadbalancing/IpAddressType:IpAddressType": { "type": "string", "enum": [ { "name": "Ipv4", "value": "ipv4" }, { "name": "Dualstack", "value": "dualstack" } ] }, "aws:applicationloadbalancing/LoadBalancerType:LoadBalancerType": { "type": "string", "enum": [ { "name": "Application", "value": "application" }, { "name": "Network", "value": "network" } ] }, "aws:appmesh/GatewayRouteSpec:GatewayRouteSpec": { "properties": { "grpcRoute": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecGrpcRoute:GatewayRouteSpecGrpcRoute", "description": "Specification of a gRPC gateway route.\n" }, "http2Route": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2Route:GatewayRouteSpecHttp2Route", "description": "Specification of an HTTP/2 gateway route.\n" }, "httpRoute": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRoute:GatewayRouteSpecHttpRoute", "description": "Specification of an HTTP gateway route.\n" }, "priority": { "type": "integer", "description": "Priority for the gateway route, between `0` and `1000`.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecGrpcRoute:GatewayRouteSpecGrpcRoute": { "properties": { "action": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecGrpcRouteAction:GatewayRouteSpecGrpcRouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecGrpcRouteMatch:GatewayRouteSpecGrpcRouteMatch", "description": "Criteria for determining a request match.\n" } }, "type": "object", "required": [ "action", "match" ] }, "aws:appmesh/GatewayRouteSpecGrpcRouteAction:GatewayRouteSpecGrpcRouteAction": { "properties": { "target": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecGrpcRouteActionTarget:GatewayRouteSpecGrpcRouteActionTarget", "description": "Target that traffic is routed to when a request matches the gateway route.\n" } }, "type": "object", "required": [ "target" ] }, "aws:appmesh/GatewayRouteSpecGrpcRouteActionTarget:GatewayRouteSpecGrpcRouteActionTarget": { "properties": { "port": { "type": "integer", "description": "The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.\n" }, "virtualService": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecGrpcRouteActionTargetVirtualService:GatewayRouteSpecGrpcRouteActionTargetVirtualService", "description": "Virtual service gateway route target.\n" } }, "type": "object", "required": [ "virtualService" ] }, "aws:appmesh/GatewayRouteSpecGrpcRouteActionTargetVirtualService:GatewayRouteSpecGrpcRouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string", "description": "Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualServiceName" ] }, "aws:appmesh/GatewayRouteSpecGrpcRouteMatch:GatewayRouteSpecGrpcRouteMatch": { "properties": { "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "serviceName": { "type": "string", "description": "Fully qualified domain name for the service to match from the request.\n" } }, "type": "object", "required": [ "serviceName" ] }, "aws:appmesh/GatewayRouteSpecHttp2Route:GatewayRouteSpecHttp2Route": { "properties": { "action": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteAction:GatewayRouteSpecHttp2RouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatch:GatewayRouteSpecHttp2RouteMatch", "description": "Criteria for determining a request match.\n" } }, "type": "object", "required": [ "action", "match" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteAction:GatewayRouteSpecHttp2RouteAction": { "properties": { "rewrite": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionRewrite:GatewayRouteSpecHttp2RouteActionRewrite", "description": "Gateway route action to rewrite.\n" }, "target": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionTarget:GatewayRouteSpecHttp2RouteActionTarget", "description": "Target that traffic is routed to when a request matches the gateway route.\n" } }, "type": "object", "required": [ "target" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionRewrite:GatewayRouteSpecHttp2RouteActionRewrite": { "properties": { "hostname": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionRewriteHostname:GatewayRouteSpecHttp2RouteActionRewriteHostname", "description": "Host name to rewrite.\n" }, "path": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionRewritePath:GatewayRouteSpecHttp2RouteActionRewritePath", "description": "Exact path to rewrite.\n" }, "prefix": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionRewritePrefix:GatewayRouteSpecHttp2RouteActionRewritePrefix", "description": "Specified beginning characters to rewrite.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionRewriteHostname:GatewayRouteSpecHttp2RouteActionRewriteHostname": { "properties": { "defaultTargetHostname": { "type": "string", "description": "Default target host name to write to. Valid values: `ENABLED`, `DISABLED`.\n" } }, "type": "object", "required": [ "defaultTargetHostname" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionRewritePath:GatewayRouteSpecHttp2RouteActionRewritePath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" } }, "type": "object", "required": [ "exact" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionRewritePrefix:GatewayRouteSpecHttp2RouteActionRewritePrefix": { "properties": { "defaultPrefix": { "type": "string", "description": "Default prefix used to replace the incoming route prefix when rewritten. Valid values: `ENABLED`, `DISABLED`.\n" }, "value": { "type": "string", "description": "Value used to replace the incoming route prefix when rewritten.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionTarget:GatewayRouteSpecHttp2RouteActionTarget": { "properties": { "port": { "type": "integer", "description": "The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.\n" }, "virtualService": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteActionTargetVirtualService:GatewayRouteSpecHttp2RouteActionTargetVirtualService", "description": "Virtual service gateway route target.\n" } }, "type": "object", "required": [ "virtualService" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteActionTargetVirtualService:GatewayRouteSpecHttp2RouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string", "description": "Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualServiceName" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatch:GatewayRouteSpecHttp2RouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeader:GatewayRouteSpecHttp2RouteMatchHeader" }, "description": "Client request headers to match on.\n" }, "hostname": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchHostname:GatewayRouteSpecHttp2RouteMatchHostname", "description": "Host name to match on.\n" }, "path": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchPath:GatewayRouteSpecHttp2RouteMatchPath", "description": "Client request path to match on.\n" }, "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "prefix": { "type": "string", "description": "Path to match requests with. This parameter must always start with `/`, which by itself matches all requests to the virtual service name.\n" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchQueryParameter:GatewayRouteSpecHttp2RouteMatchQueryParameter" }, "description": "Client request query parameters to match on.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeader:GatewayRouteSpecHttp2RouteMatchHeader": { "properties": { "invert": { "type": "boolean", "description": "If `true`, the match is on the opposite of the `match` method and value. Default is `false`.\n" }, "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeaderMatch:GatewayRouteSpecHttp2RouteMatchHeaderMatch", "description": "Method and value to match the header value sent with a request. Specify one match method.\n" }, "name": { "type": "string", "description": "Name for the HTTP header in the client request that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeaderMatch:GatewayRouteSpecHttp2RouteMatchHeaderMatch": { "properties": { "exact": { "type": "string", "description": "Header value sent by the client must match the specified value exactly.\n" }, "prefix": { "type": "string", "description": "Header value sent by the client must begin with the specified characters.\n" }, "range": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeaderMatchRange:GatewayRouteSpecHttp2RouteMatchHeaderMatchRange", "description": "Object that specifies the range of numbers that the header value sent by the client must be included in.\n" }, "regex": { "type": "string", "description": "Header value sent by the client must include the specified characters.\n" }, "suffix": { "type": "string", "description": "Header value sent by the client must end with the specified characters.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchHeaderMatchRange:GatewayRouteSpecHttp2RouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer", "description": "End of the range.\n" }, "start": { "type": "integer", "description": "Start of the range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchHostname:GatewayRouteSpecHttp2RouteMatchHostname": { "properties": { "exact": { "type": "string", "description": "Exact host name to match on.\n" }, "suffix": { "type": "string", "description": "Specified ending characters of the host name to match on.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchPath:GatewayRouteSpecHttp2RouteMatchPath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" }, "regex": { "type": "string", "description": "The regex used to match the path.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchQueryParameter:GatewayRouteSpecHttp2RouteMatchQueryParameter": { "properties": { "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttp2RouteMatchQueryParameterMatch:GatewayRouteSpecHttp2RouteMatchQueryParameterMatch", "description": "The query parameter to match on.\n" }, "name": { "type": "string", "description": "Name for the query parameter that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/GatewayRouteSpecHttp2RouteMatchQueryParameterMatch:GatewayRouteSpecHttp2RouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string", "description": "The exact query parameter to match on.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRoute:GatewayRouteSpecHttpRoute": { "properties": { "action": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteAction:GatewayRouteSpecHttpRouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatch:GatewayRouteSpecHttpRouteMatch", "description": "Criteria for determining a request match.\n" } }, "type": "object", "required": [ "action", "match" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteAction:GatewayRouteSpecHttpRouteAction": { "properties": { "rewrite": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionRewrite:GatewayRouteSpecHttpRouteActionRewrite", "description": "Gateway route action to rewrite.\n" }, "target": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionTarget:GatewayRouteSpecHttpRouteActionTarget", "description": "Target that traffic is routed to when a request matches the gateway route.\n" } }, "type": "object", "required": [ "target" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteActionRewrite:GatewayRouteSpecHttpRouteActionRewrite": { "properties": { "hostname": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionRewriteHostname:GatewayRouteSpecHttpRouteActionRewriteHostname", "description": "Host name to rewrite.\n" }, "path": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionRewritePath:GatewayRouteSpecHttpRouteActionRewritePath", "description": "Exact path to rewrite.\n" }, "prefix": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionRewritePrefix:GatewayRouteSpecHttpRouteActionRewritePrefix", "description": "Specified beginning characters to rewrite.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteActionRewriteHostname:GatewayRouteSpecHttpRouteActionRewriteHostname": { "properties": { "defaultTargetHostname": { "type": "string", "description": "Default target host name to write to. Valid values: `ENABLED`, `DISABLED`.\n" } }, "type": "object", "required": [ "defaultTargetHostname" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteActionRewritePath:GatewayRouteSpecHttpRouteActionRewritePath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" } }, "type": "object", "required": [ "exact" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteActionRewritePrefix:GatewayRouteSpecHttpRouteActionRewritePrefix": { "properties": { "defaultPrefix": { "type": "string", "description": "Default prefix used to replace the incoming route prefix when rewritten. Valid values: `ENABLED`, `DISABLED`.\n" }, "value": { "type": "string", "description": "Value used to replace the incoming route prefix when rewritten.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteActionTarget:GatewayRouteSpecHttpRouteActionTarget": { "properties": { "port": { "type": "integer", "description": "The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.\n" }, "virtualService": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteActionTargetVirtualService:GatewayRouteSpecHttpRouteActionTargetVirtualService", "description": "Virtual service gateway route target.\n" } }, "type": "object", "required": [ "virtualService" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteActionTargetVirtualService:GatewayRouteSpecHttpRouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string", "description": "Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualServiceName" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteMatch:GatewayRouteSpecHttpRouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchHeader:GatewayRouteSpecHttpRouteMatchHeader" }, "description": "Client request headers to match on.\n" }, "hostname": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchHostname:GatewayRouteSpecHttpRouteMatchHostname", "description": "Host name to match on.\n" }, "path": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchPath:GatewayRouteSpecHttpRouteMatchPath", "description": "Client request path to match on.\n" }, "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "prefix": { "type": "string", "description": "Path to match requests with. This parameter must always start with `/`, which by itself matches all requests to the virtual service name.\n" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchQueryParameter:GatewayRouteSpecHttpRouteMatchQueryParameter" }, "description": "Client request query parameters to match on.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchHeader:GatewayRouteSpecHttpRouteMatchHeader": { "properties": { "invert": { "type": "boolean", "description": "If `true`, the match is on the opposite of the `match` method and value. Default is `false`.\n" }, "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchHeaderMatch:GatewayRouteSpecHttpRouteMatchHeaderMatch", "description": "Method and value to match the header value sent with a request. Specify one match method.\n" }, "name": { "type": "string", "description": "Name for the HTTP header in the client request that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchHeaderMatch:GatewayRouteSpecHttpRouteMatchHeaderMatch": { "properties": { "exact": { "type": "string", "description": "Header value sent by the client must match the specified value exactly.\n" }, "prefix": { "type": "string", "description": "Header value sent by the client must begin with the specified characters.\n" }, "range": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchHeaderMatchRange:GatewayRouteSpecHttpRouteMatchHeaderMatchRange", "description": "Object that specifies the range of numbers that the header value sent by the client must be included in.\n" }, "regex": { "type": "string", "description": "Header value sent by the client must include the specified characters.\n" }, "suffix": { "type": "string", "description": "Header value sent by the client must end with the specified characters.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchHeaderMatchRange:GatewayRouteSpecHttpRouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer", "description": "End of the range.\n" }, "start": { "type": "integer", "description": "Start of the range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchHostname:GatewayRouteSpecHttpRouteMatchHostname": { "properties": { "exact": { "type": "string", "description": "Exact host name to match on.\n" }, "suffix": { "type": "string", "description": "Specified ending characters of the host name to match on.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchPath:GatewayRouteSpecHttpRouteMatchPath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" }, "regex": { "type": "string", "description": "The regex used to match the path.\n" } }, "type": "object" }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchQueryParameter:GatewayRouteSpecHttpRouteMatchQueryParameter": { "properties": { "match": { "$ref": "#/types/aws:appmesh/GatewayRouteSpecHttpRouteMatchQueryParameterMatch:GatewayRouteSpecHttpRouteMatchQueryParameterMatch", "description": "The query parameter to match on.\n" }, "name": { "type": "string", "description": "Name for the query parameter that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/GatewayRouteSpecHttpRouteMatchQueryParameterMatch:GatewayRouteSpecHttpRouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string", "description": "The exact query parameter to match on.\n" } }, "type": "object" }, "aws:appmesh/MeshSpec:MeshSpec": { "properties": { "egressFilter": { "$ref": "#/types/aws:appmesh/MeshSpecEgressFilter:MeshSpecEgressFilter", "description": "Egress filter rules for the service mesh.\n" }, "serviceDiscovery": { "$ref": "#/types/aws:appmesh/MeshSpecServiceDiscovery:MeshSpecServiceDiscovery", "description": "The service discovery information for the service mesh.\n" } }, "type": "object" }, "aws:appmesh/MeshSpecEgressFilter:MeshSpecEgressFilter": { "properties": { "type": { "type": "string", "description": "Egress filter type. By default, the type is `DROP_ALL`. Valid values are `ALLOW_ALL` and `DROP_ALL`.\n" } }, "type": "object" }, "aws:appmesh/MeshSpecServiceDiscovery:MeshSpecServiceDiscovery": { "properties": { "ipPreference": { "type": "string", "description": "The IP version to use to control traffic within the mesh. Valid values are `IPv6_PREFERRED`, `IPv4_PREFERRED`, `IPv4_ONLY`, and `IPv6_ONLY`.\n" } }, "type": "object" }, "aws:appmesh/RouteSpec:RouteSpec": { "properties": { "grpcRoute": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRoute:RouteSpecGrpcRoute", "description": "GRPC routing information for the route.\n" }, "http2Route": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2Route:RouteSpecHttp2Route", "description": "HTTP/2 routing information for the route.\n" }, "httpRoute": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRoute:RouteSpecHttpRoute", "description": "HTTP routing information for the route.\n" }, "priority": { "type": "integer", "description": "Priority for the route, between `0` and `1000`.\nRoutes are matched based on the specified value, where `0` is the highest priority.\n" }, "tcpRoute": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRoute:RouteSpecTcpRoute", "description": "TCP routing information for the route.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecGrpcRoute:RouteSpecGrpcRoute": { "properties": { "action": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteAction:RouteSpecGrpcRouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteMatch:RouteSpecGrpcRouteMatch", "description": "Criteria for determining an gRPC request match.\n" }, "retryPolicy": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteRetryPolicy:RouteSpecGrpcRouteRetryPolicy", "description": "Retry policy.\n" }, "timeout": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteTimeout:RouteSpecGrpcRouteTimeout", "description": "Types of timeouts.\n" } }, "type": "object", "required": [ "action" ] }, "aws:appmesh/RouteSpecGrpcRouteAction:RouteSpecGrpcRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteActionWeightedTarget:RouteSpecGrpcRouteActionWeightedTarget" }, "description": "Targets that traffic is routed to when a request matches the route.\nYou can specify one or more targets and their relative weights with which to distribute traffic.\n" } }, "type": "object", "required": [ "weightedTargets" ] }, "aws:appmesh/RouteSpecGrpcRouteActionWeightedTarget:RouteSpecGrpcRouteActionWeightedTarget": { "properties": { "port": { "type": "integer", "description": "The targeted port of the weighted object.\n" }, "virtualNode": { "type": "string", "description": "Virtual node to associate with the weighted target. Must be between 1 and 255 characters in length.\n" }, "weight": { "type": "integer", "description": "Relative weight of the weighted target. An integer between 0 and 100.\n" } }, "type": "object", "required": [ "virtualNode", "weight" ], "language": { "nodejs": { "requiredOutputs": [ "port", "virtualNode", "weight" ] } } }, "aws:appmesh/RouteSpecGrpcRouteMatch:RouteSpecGrpcRouteMatch": { "properties": { "metadatas": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteMatchMetadata:RouteSpecGrpcRouteMatchMetadata" }, "description": "Data to match from the gRPC request.\n" }, "methodName": { "type": "string", "description": "Method name to match from the request. If you specify a name, you must also specify a `service_name`.\n" }, "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "prefix": { "type": "string" }, "serviceName": { "type": "string", "description": "Fully qualified domain name for the service to match from the request.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecGrpcRouteMatchMetadata:RouteSpecGrpcRouteMatchMetadata": { "properties": { "invert": { "type": "boolean", "description": "If `true`, the match is on the opposite of the `match` criteria. Default is `false`.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteMatchMetadataMatch:RouteSpecGrpcRouteMatchMetadataMatch", "description": "Data to match from the request.\n" }, "name": { "type": "string", "description": "Name of the route. Must be between 1 and 50 characters in length.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/RouteSpecGrpcRouteMatchMetadataMatch:RouteSpecGrpcRouteMatchMetadataMatch": { "properties": { "exact": { "type": "string", "description": "Value sent by the client must match the specified value exactly. Must be between 1 and 255 characters in length.\n" }, "prefix": { "type": "string", "description": "Value sent by the client must begin with the specified characters. Must be between 1 and 255 characters in length.\n" }, "range": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteMatchMetadataMatchRange:RouteSpecGrpcRouteMatchMetadataMatchRange", "description": "Object that specifies the range of numbers that the value sent by the client must be included in.\n" }, "regex": { "type": "string", "description": "Value sent by the client must include the specified characters. Must be between 1 and 255 characters in length.\n" }, "suffix": { "type": "string", "description": "Value sent by the client must end with the specified characters. Must be between 1 and 255 characters in length.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecGrpcRouteMatchMetadataMatchRange:RouteSpecGrpcRouteMatchMetadataMatchRange": { "properties": { "end": { "type": "integer", "description": "End of the range.\n" }, "start": { "type": "integer", "description": "Start of the range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:appmesh/RouteSpecGrpcRouteRetryPolicy:RouteSpecGrpcRouteRetryPolicy": { "properties": { "grpcRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of gRPC retry events.\nValid values: `cancelled`, `deadline-exceeded`, `internal`, `resource-exhausted`, `unavailable`.\n" }, "httpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of HTTP retry events.\nValid values: `client-error` (HTTP status code 409), `gateway-error` (HTTP status codes 502, 503, and 504), `server-error` (HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511), `stream-error` (retry on refused stream).\n" }, "maxRetries": { "type": "integer", "description": "Maximum number of retries.\n" }, "perRetryTimeout": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteRetryPolicyPerRetryTimeout:RouteSpecGrpcRouteRetryPolicyPerRetryTimeout", "description": "Per-retry timeout.\n" }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of TCP retry events. The only valid value is `connection-error`.\n" } }, "type": "object", "required": [ "maxRetries", "perRetryTimeout" ] }, "aws:appmesh/RouteSpecGrpcRouteRetryPolicyPerRetryTimeout:RouteSpecGrpcRouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string", "description": "Retry unit. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Retry value.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecGrpcRouteTimeout:RouteSpecGrpcRouteTimeout": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteTimeoutIdle:RouteSpecGrpcRouteTimeoutIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/RouteSpecGrpcRouteTimeoutPerRequest:RouteSpecGrpcRouteTimeoutPerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecGrpcRouteTimeoutIdle:RouteSpecGrpcRouteTimeoutIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecGrpcRouteTimeoutPerRequest:RouteSpecGrpcRouteTimeoutPerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttp2Route:RouteSpecHttp2Route": { "properties": { "action": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteAction:RouteSpecHttp2RouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatch:RouteSpecHttp2RouteMatch", "description": "Criteria for determining an HTTP request match.\n" }, "retryPolicy": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteRetryPolicy:RouteSpecHttp2RouteRetryPolicy", "description": "Retry policy.\n" }, "timeout": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteTimeout:RouteSpecHttp2RouteTimeout", "description": "Types of timeouts.\n" } }, "type": "object", "required": [ "action", "match" ] }, "aws:appmesh/RouteSpecHttp2RouteAction:RouteSpecHttp2RouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteActionWeightedTarget:RouteSpecHttp2RouteActionWeightedTarget" }, "description": "Targets that traffic is routed to when a request matches the route.\nYou can specify one or more targets and their relative weights with which to distribute traffic.\n" } }, "type": "object", "required": [ "weightedTargets" ] }, "aws:appmesh/RouteSpecHttp2RouteActionWeightedTarget:RouteSpecHttp2RouteActionWeightedTarget": { "properties": { "port": { "type": "integer", "description": "The targeted port of the weighted object.\n" }, "virtualNode": { "type": "string", "description": "Virtual node to associate with the weighted target. Must be between 1 and 255 characters in length.\n" }, "weight": { "type": "integer", "description": "Relative weight of the weighted target. An integer between 0 and 100.\n" } }, "type": "object", "required": [ "virtualNode", "weight" ], "language": { "nodejs": { "requiredOutputs": [ "port", "virtualNode", "weight" ] } } }, "aws:appmesh/RouteSpecHttp2RouteMatch:RouteSpecHttp2RouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchHeader:RouteSpecHttp2RouteMatchHeader" }, "description": "Client request headers to match on.\n" }, "method": { "type": "string", "description": "Client request header method to match on. Valid values: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`.\n" }, "path": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchPath:RouteSpecHttp2RouteMatchPath", "description": "Client request path to match on.\n" }, "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "prefix": { "type": "string", "description": "Path with which to match requests.\nThis parameter must always start with /, which by itself matches all requests to the virtual router service name.\n" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchQueryParameter:RouteSpecHttp2RouteMatchQueryParameter" }, "description": "Client request query parameters to match on.\n" }, "scheme": { "type": "string", "description": "Client request header scheme to match on. Valid values: `http`, `https`.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttp2RouteMatchHeader:RouteSpecHttp2RouteMatchHeader": { "properties": { "invert": { "type": "boolean", "description": "If `true`, the match is on the opposite of the `match` method and value. Default is `false`.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchHeaderMatch:RouteSpecHttp2RouteMatchHeaderMatch", "description": "Method and value to match the header value sent with a request. Specify one match method.\n" }, "name": { "type": "string", "description": "Name for the HTTP header in the client request that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/RouteSpecHttp2RouteMatchHeaderMatch:RouteSpecHttp2RouteMatchHeaderMatch": { "properties": { "exact": { "type": "string", "description": "Header value sent by the client must match the specified value exactly.\n" }, "prefix": { "type": "string", "description": "Header value sent by the client must begin with the specified characters.\n" }, "range": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchHeaderMatchRange:RouteSpecHttp2RouteMatchHeaderMatchRange", "description": "Object that specifies the range of numbers that the header value sent by the client must be included in.\n" }, "regex": { "type": "string", "description": "Header value sent by the client must include the specified characters.\n" }, "suffix": { "type": "string", "description": "Header value sent by the client must end with the specified characters.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttp2RouteMatchHeaderMatchRange:RouteSpecHttp2RouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer", "description": "End of the range.\n" }, "start": { "type": "integer", "description": "Start of the range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:appmesh/RouteSpecHttp2RouteMatchPath:RouteSpecHttp2RouteMatchPath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" }, "regex": { "type": "string", "description": "The regex used to match the path.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttp2RouteMatchQueryParameter:RouteSpecHttp2RouteMatchQueryParameter": { "properties": { "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteMatchQueryParameterMatch:RouteSpecHttp2RouteMatchQueryParameterMatch", "description": "The query parameter to match on.\n" }, "name": { "type": "string", "description": "Name for the query parameter that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/RouteSpecHttp2RouteMatchQueryParameterMatch:RouteSpecHttp2RouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string", "description": "The exact query parameter to match on.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttp2RouteRetryPolicy:RouteSpecHttp2RouteRetryPolicy": { "properties": { "httpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of HTTP retry events.\nValid values: `client-error` (HTTP status code 409), `gateway-error` (HTTP status codes 502, 503, and 504), `server-error` (HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511), `stream-error` (retry on refused stream).\n" }, "maxRetries": { "type": "integer", "description": "Maximum number of retries.\n" }, "perRetryTimeout": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteRetryPolicyPerRetryTimeout:RouteSpecHttp2RouteRetryPolicyPerRetryTimeout", "description": "Per-retry timeout.\n" }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of TCP retry events. The only valid value is `connection-error`.\n\nYou must specify at least one value for `http_retry_events`, or at least one value for `tcp_retry_events`.\n" } }, "type": "object", "required": [ "maxRetries", "perRetryTimeout" ] }, "aws:appmesh/RouteSpecHttp2RouteRetryPolicyPerRetryTimeout:RouteSpecHttp2RouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string", "description": "Retry unit. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Retry value.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttp2RouteTimeout:RouteSpecHttp2RouteTimeout": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteTimeoutIdle:RouteSpecHttp2RouteTimeoutIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/RouteSpecHttp2RouteTimeoutPerRequest:RouteSpecHttp2RouteTimeoutPerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttp2RouteTimeoutIdle:RouteSpecHttp2RouteTimeoutIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttp2RouteTimeoutPerRequest:RouteSpecHttp2RouteTimeoutPerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttpRoute:RouteSpecHttpRoute": { "properties": { "action": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteAction:RouteSpecHttpRouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatch:RouteSpecHttpRouteMatch", "description": "Criteria for determining an HTTP request match.\n" }, "retryPolicy": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteRetryPolicy:RouteSpecHttpRouteRetryPolicy", "description": "Retry policy.\n" }, "timeout": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteTimeout:RouteSpecHttpRouteTimeout", "description": "Types of timeouts.\n" } }, "type": "object", "required": [ "action", "match" ] }, "aws:appmesh/RouteSpecHttpRouteAction:RouteSpecHttpRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteActionWeightedTarget:RouteSpecHttpRouteActionWeightedTarget" }, "description": "Targets that traffic is routed to when a request matches the route.\nYou can specify one or more targets and their relative weights with which to distribute traffic.\n" } }, "type": "object", "required": [ "weightedTargets" ] }, "aws:appmesh/RouteSpecHttpRouteActionWeightedTarget:RouteSpecHttpRouteActionWeightedTarget": { "properties": { "port": { "type": "integer", "description": "The targeted port of the weighted object.\n" }, "virtualNode": { "type": "string", "description": "Virtual node to associate with the weighted target. Must be between 1 and 255 characters in length.\n" }, "weight": { "type": "integer", "description": "Relative weight of the weighted target. An integer between 0 and 100.\n" } }, "type": "object", "required": [ "virtualNode", "weight" ], "language": { "nodejs": { "requiredOutputs": [ "port", "virtualNode", "weight" ] } } }, "aws:appmesh/RouteSpecHttpRouteMatch:RouteSpecHttpRouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchHeader:RouteSpecHttpRouteMatchHeader" }, "description": "Client request headers to match on.\n" }, "method": { "type": "string", "description": "Client request header method to match on. Valid values: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`.\n" }, "path": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchPath:RouteSpecHttpRouteMatchPath", "description": "Client request path to match on.\n" }, "port": { "type": "integer", "description": "The port number to match from the request.\n" }, "prefix": { "type": "string", "description": "Path with which to match requests.\nThis parameter must always start with /, which by itself matches all requests to the virtual router service name.\n" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchQueryParameter:RouteSpecHttpRouteMatchQueryParameter" }, "description": "Client request query parameters to match on.\n" }, "scheme": { "type": "string", "description": "Client request header scheme to match on. Valid values: `http`, `https`.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttpRouteMatchHeader:RouteSpecHttpRouteMatchHeader": { "properties": { "invert": { "type": "boolean", "description": "If `true`, the match is on the opposite of the `match` method and value. Default is `false`.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchHeaderMatch:RouteSpecHttpRouteMatchHeaderMatch", "description": "Method and value to match the header value sent with a request. Specify one match method.\n" }, "name": { "type": "string", "description": "Name for the HTTP header in the client request that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/RouteSpecHttpRouteMatchHeaderMatch:RouteSpecHttpRouteMatchHeaderMatch": { "properties": { "exact": { "type": "string", "description": "Header value sent by the client must match the specified value exactly.\n" }, "prefix": { "type": "string", "description": "Header value sent by the client must begin with the specified characters.\n" }, "range": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchHeaderMatchRange:RouteSpecHttpRouteMatchHeaderMatchRange", "description": "Object that specifies the range of numbers that the header value sent by the client must be included in.\n" }, "regex": { "type": "string", "description": "Header value sent by the client must include the specified characters.\n" }, "suffix": { "type": "string", "description": "Header value sent by the client must end with the specified characters.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttpRouteMatchHeaderMatchRange:RouteSpecHttpRouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer", "description": "End of the range.\n" }, "start": { "type": "integer", "description": "Start of the range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:appmesh/RouteSpecHttpRouteMatchPath:RouteSpecHttpRouteMatchPath": { "properties": { "exact": { "type": "string", "description": "The exact path to match on.\n" }, "regex": { "type": "string", "description": "The regex used to match the path.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttpRouteMatchQueryParameter:RouteSpecHttpRouteMatchQueryParameter": { "properties": { "match": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteMatchQueryParameterMatch:RouteSpecHttpRouteMatchQueryParameterMatch", "description": "The query parameter to match on.\n" }, "name": { "type": "string", "description": "Name for the query parameter that will be matched on.\n" } }, "type": "object", "required": [ "name" ] }, "aws:appmesh/RouteSpecHttpRouteMatchQueryParameterMatch:RouteSpecHttpRouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string", "description": "The exact query parameter to match on.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttpRouteRetryPolicy:RouteSpecHttpRouteRetryPolicy": { "properties": { "httpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of HTTP retry events.\nValid values: `client-error` (HTTP status code 409), `gateway-error` (HTTP status codes 502, 503, and 504), `server-error` (HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511), `stream-error` (retry on refused stream).\n" }, "maxRetries": { "type": "integer", "description": "Maximum number of retries.\n" }, "perRetryTimeout": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteRetryPolicyPerRetryTimeout:RouteSpecHttpRouteRetryPolicyPerRetryTimeout", "description": "Per-retry timeout.\n" }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" }, "description": "List of TCP retry events. The only valid value is `connection-error`.\n\nYou must specify at least one value for `http_retry_events`, or at least one value for `tcp_retry_events`.\n" } }, "type": "object", "required": [ "maxRetries", "perRetryTimeout" ] }, "aws:appmesh/RouteSpecHttpRouteRetryPolicyPerRetryTimeout:RouteSpecHttpRouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string", "description": "Retry unit. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Retry value.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttpRouteTimeout:RouteSpecHttpRouteTimeout": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteTimeoutIdle:RouteSpecHttpRouteTimeoutIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/RouteSpecHttpRouteTimeoutPerRequest:RouteSpecHttpRouteTimeoutPerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecHttpRouteTimeoutIdle:RouteSpecHttpRouteTimeoutIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecHttpRouteTimeoutPerRequest:RouteSpecHttpRouteTimeoutPerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/RouteSpecTcpRoute:RouteSpecTcpRoute": { "properties": { "action": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRouteAction:RouteSpecTcpRouteAction", "description": "Action to take if a match is determined.\n" }, "match": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRouteMatch:RouteSpecTcpRouteMatch" }, "timeout": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRouteTimeout:RouteSpecTcpRouteTimeout", "description": "Types of timeouts.\n" } }, "type": "object", "required": [ "action" ] }, "aws:appmesh/RouteSpecTcpRouteAction:RouteSpecTcpRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRouteActionWeightedTarget:RouteSpecTcpRouteActionWeightedTarget" }, "description": "Targets that traffic is routed to when a request matches the route.\nYou can specify one or more targets and their relative weights with which to distribute traffic.\n" } }, "type": "object", "required": [ "weightedTargets" ] }, "aws:appmesh/RouteSpecTcpRouteActionWeightedTarget:RouteSpecTcpRouteActionWeightedTarget": { "properties": { "port": { "type": "integer", "description": "The targeted port of the weighted object.\n" }, "virtualNode": { "type": "string", "description": "Virtual node to associate with the weighted target. Must be between 1 and 255 characters in length.\n" }, "weight": { "type": "integer", "description": "Relative weight of the weighted target. An integer between 0 and 100.\n" } }, "type": "object", "required": [ "virtualNode", "weight" ], "language": { "nodejs": { "requiredOutputs": [ "port", "virtualNode", "weight" ] } } }, "aws:appmesh/RouteSpecTcpRouteMatch:RouteSpecTcpRouteMatch": { "properties": { "port": { "type": "integer" } }, "type": "object" }, "aws:appmesh/RouteSpecTcpRouteTimeout:RouteSpecTcpRouteTimeout": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/RouteSpecTcpRouteTimeoutIdle:RouteSpecTcpRouteTimeoutIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" } }, "type": "object" }, "aws:appmesh/RouteSpecTcpRouteTimeoutIdle:RouteSpecTcpRouteTimeoutIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualGatewaySpec:VirtualGatewaySpec": { "properties": { "backendDefaults": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaults:VirtualGatewaySpecBackendDefaults", "description": "Defaults for backends.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListener:VirtualGatewaySpecListener" }, "description": "Listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.\n" }, "logging": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecLogging:VirtualGatewaySpecLogging", "description": "Inbound and outbound access logging information for the virtual gateway.\n" } }, "type": "object", "required": [ "listeners" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaults:VirtualGatewaySpecBackendDefaults": { "properties": { "clientPolicy": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicy:VirtualGatewaySpecBackendDefaultsClientPolicy", "description": "Default client policy for virtual gateway backends.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicy:VirtualGatewaySpecBackendDefaultsClientPolicy": { "properties": { "tls": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTls:VirtualGatewaySpecBackendDefaultsClientPolicyTls", "description": "Transport Layer Security (TLS) client policy.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTls:VirtualGatewaySpecBackendDefaultsClientPolicyTls": { "properties": { "certificate": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificate:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificate", "description": "Listener's TLS certificate.\n" }, "enforce": { "type": "boolean", "description": "Whether the policy is enforced. Default is `true`.\n" }, "ports": { "type": "array", "items": { "type": "integer" }, "description": "One or more ports that the policy is enforced for.\n" }, "validation": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidation:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidation", "description": "Listener's Transport Layer Security (TLS) validation context.\n" } }, "type": "object", "required": [ "validation" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificate:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificate": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateFile:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateFile", "description": "Local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateSds:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateSds", "description": "A [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateFile:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" }, "privateKey": { "type": "string", "description": "Private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain", "privateKey" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateSds:VirtualGatewaySpecBackendDefaultsClientPolicyTlsCertificateSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidation:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidation": { "properties": { "subjectAlternativeNames": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames", "description": "SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.\n" }, "trust": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrust:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrust", "description": "TLS validation context trust.\n" } }, "type": "object", "required": [ "trust" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames": { "properties": { "match": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch", "description": "Criteria for determining a SAN's match.\n" } }, "type": "object", "required": [ "match" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" }, "description": "Values sent must match the specified values exactly.\n" } }, "type": "object", "required": [ "exacts" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrust:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrust": { "properties": { "acm": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustAcm:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustAcm", "description": "TLS validation context trust for an AWS Certificate Manager (ACM) certificate.\n" }, "file": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustFile:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustFile", "description": "TLS validation context trust for a local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustSds:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustSds", "description": "TLS validation context trust for a [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustAcm:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" }, "description": "One or more ACM ARNs.\n" } }, "type": "object", "required": [ "certificateAuthorityArns" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustFile:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain" ] }, "aws:appmesh/VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustSds:VirtualGatewaySpecBackendDefaultsClientPolicyTlsValidationTrustSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualGatewaySpecListener:VirtualGatewaySpecListener": { "properties": { "connectionPool": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerConnectionPool:VirtualGatewaySpecListenerConnectionPool", "description": "Connection pool information for the listener.\n" }, "healthCheck": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerHealthCheck:VirtualGatewaySpecListenerHealthCheck", "description": "Health check information for the listener.\n" }, "portMapping": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerPortMapping:VirtualGatewaySpecListenerPortMapping", "description": "Port mapping information for the listener.\n" }, "tls": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTls:VirtualGatewaySpecListenerTls", "description": "Transport Layer Security (TLS) properties for the listener\n" } }, "type": "object", "required": [ "portMapping" ] }, "aws:appmesh/VirtualGatewaySpecListenerConnectionPool:VirtualGatewaySpecListenerConnectionPool": { "properties": { "grpc": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerConnectionPoolGrpc:VirtualGatewaySpecListenerConnectionPoolGrpc", "description": "Connection pool information for gRPC listeners.\n" }, "http": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerConnectionPoolHttp:VirtualGatewaySpecListenerConnectionPoolHttp", "description": "Connection pool information for HTTP listeners.\n" }, "http2": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerConnectionPoolHttp2:VirtualGatewaySpecListenerConnectionPoolHttp2", "description": "Connection pool information for HTTP2 listeners.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecListenerConnectionPoolGrpc:VirtualGatewaySpecListenerConnectionPoolGrpc": { "properties": { "maxRequests": { "type": "integer", "description": "Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxRequests" ] }, "aws:appmesh/VirtualGatewaySpecListenerConnectionPoolHttp2:VirtualGatewaySpecListenerConnectionPoolHttp2": { "properties": { "maxRequests": { "type": "integer", "description": "Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxRequests" ] }, "aws:appmesh/VirtualGatewaySpecListenerConnectionPoolHttp:VirtualGatewaySpecListenerConnectionPoolHttp": { "properties": { "maxConnections": { "type": "integer", "description": "Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. Minimum value of `1`.\n" }, "maxPendingRequests": { "type": "integer", "description": "Number of overflowing requests after `max_connections` Envoy will queue to upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxConnections" ] }, "aws:appmesh/VirtualGatewaySpecListenerHealthCheck:VirtualGatewaySpecListenerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer", "description": "Number of consecutive successful health checks that must occur before declaring listener healthy.\n" }, "intervalMillis": { "type": "integer", "description": "Time period in milliseconds between each health check execution.\n" }, "path": { "type": "string", "description": "Destination path for the health check request. This is only required if the specified protocol is `http` or `http2`.\n" }, "port": { "type": "integer", "description": "Destination port for the health check request. This port must match the port defined in the `port_mapping` for the listener.\n" }, "protocol": { "type": "string", "description": "Protocol for the health check request. Valid values are `http`, `http2`, and `grpc`.\n" }, "timeoutMillis": { "type": "integer", "description": "Amount of time to wait when receiving a response from the health check, in milliseconds.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.\n" } }, "type": "object", "required": [ "healthyThreshold", "intervalMillis", "protocol", "timeoutMillis", "unhealthyThreshold" ], "language": { "nodejs": { "requiredOutputs": [ "healthyThreshold", "intervalMillis", "port", "protocol", "timeoutMillis", "unhealthyThreshold" ] } } }, "aws:appmesh/VirtualGatewaySpecListenerPortMapping:VirtualGatewaySpecListenerPortMapping": { "properties": { "port": { "type": "integer", "description": "Port used for the port mapping.\n" }, "protocol": { "type": "string", "description": "Protocol used for the port mapping. Valid values are `http`, `http2`, `tcp` and `grpc`.\n" } }, "type": "object", "required": [ "port", "protocol" ] }, "aws:appmesh/VirtualGatewaySpecListenerTls:VirtualGatewaySpecListenerTls": { "properties": { "certificate": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsCertificate:VirtualGatewaySpecListenerTlsCertificate", "description": "Listener's TLS certificate.\n" }, "mode": { "type": "string", "description": "Listener's TLS mode. Valid values: `DISABLED`, `PERMISSIVE`, `STRICT`.\n" }, "validation": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidation:VirtualGatewaySpecListenerTlsValidation", "description": "Listener's Transport Layer Security (TLS) validation context.\n" } }, "type": "object", "required": [ "certificate", "mode" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsCertificate:VirtualGatewaySpecListenerTlsCertificate": { "properties": { "acm": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsCertificateAcm:VirtualGatewaySpecListenerTlsCertificateAcm", "description": "An AWS Certificate Manager (ACM) certificate.\n" }, "file": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsCertificateFile:VirtualGatewaySpecListenerTlsCertificateFile", "description": "Local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsCertificateSds:VirtualGatewaySpecListenerTlsCertificateSds", "description": "A [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecListenerTlsCertificateAcm:VirtualGatewaySpecListenerTlsCertificateAcm": { "properties": { "certificateArn": { "type": "string", "description": "ARN for the certificate.\n" } }, "type": "object", "required": [ "certificateArn" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsCertificateFile:VirtualGatewaySpecListenerTlsCertificateFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" }, "privateKey": { "type": "string", "description": "Private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain", "privateKey" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsCertificateSds:VirtualGatewaySpecListenerTlsCertificateSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidation:VirtualGatewaySpecListenerTlsValidation": { "properties": { "subjectAlternativeNames": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNames:VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNames", "description": "SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.\n" }, "trust": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrust:VirtualGatewaySpecListenerTlsValidationTrust", "description": "TLS validation context trust.\n" } }, "type": "object", "required": [ "trust" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNames:VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNames": { "properties": { "match": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNamesMatch:VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNamesMatch", "description": "Criteria for determining a SAN's match.\n" } }, "type": "object", "required": [ "match" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNamesMatch:VirtualGatewaySpecListenerTlsValidationSubjectAlternativeNamesMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" }, "description": "Values sent must match the specified values exactly.\n" } }, "type": "object", "required": [ "exacts" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrust:VirtualGatewaySpecListenerTlsValidationTrust": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrustFile:VirtualGatewaySpecListenerTlsValidationTrustFile", "description": "TLS validation context trust for a local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrustSds:VirtualGatewaySpecListenerTlsValidationTrustSds", "description": "TLS validation context trust for a [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrustFile:VirtualGatewaySpecListenerTlsValidationTrustFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain" ] }, "aws:appmesh/VirtualGatewaySpecListenerTlsValidationTrustSds:VirtualGatewaySpecListenerTlsValidationTrustSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualGatewaySpecLogging:VirtualGatewaySpecLogging": { "properties": { "accessLog": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecLoggingAccessLog:VirtualGatewaySpecLoggingAccessLog", "description": "Access log configuration for a virtual gateway.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecLoggingAccessLog:VirtualGatewaySpecLoggingAccessLog": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecLoggingAccessLogFile:VirtualGatewaySpecLoggingAccessLogFile", "description": "File object to send virtual gateway access logs to.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecLoggingAccessLogFile:VirtualGatewaySpecLoggingAccessLogFile": { "properties": { "format": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecLoggingAccessLogFileFormat:VirtualGatewaySpecLoggingAccessLogFileFormat", "description": "The specified format for the logs.\n" }, "path": { "type": "string", "description": "File path to write access logs to. You can use `/dev/stdout` to send access logs to standard out. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "path" ] }, "aws:appmesh/VirtualGatewaySpecLoggingAccessLogFileFormat:VirtualGatewaySpecLoggingAccessLogFileFormat": { "properties": { "jsons": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualGatewaySpecLoggingAccessLogFileFormatJson:VirtualGatewaySpecLoggingAccessLogFileFormatJson" }, "description": "The logging format for JSON.\n" }, "text": { "type": "string", "description": "The logging format for text. Must be between 1 and 1000 characters in length.\n" } }, "type": "object" }, "aws:appmesh/VirtualGatewaySpecLoggingAccessLogFileFormatJson:VirtualGatewaySpecLoggingAccessLogFileFormatJson": { "properties": { "key": { "type": "string", "description": "The specified key for the JSON. Must be between 1 and 100 characters in length.\n" }, "value": { "type": "string", "description": "The specified value for the JSON. Must be between 1 and 100 characters in length.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:appmesh/VirtualNodeSpec:VirtualNodeSpec": { "properties": { "backendDefaults": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaults:VirtualNodeSpecBackendDefaults", "description": "Defaults for backends.\n" }, "backends": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackend:VirtualNodeSpecBackend" }, "description": "Backends to which the virtual node is expected to send outbound traffic.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListener:VirtualNodeSpecListener" }, "description": "Listeners from which the virtual node is expected to receive inbound traffic.\n" }, "logging": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecLogging:VirtualNodeSpecLogging", "description": "Inbound and outbound access logging information for the virtual node.\n" }, "serviceDiscovery": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecServiceDiscovery:VirtualNodeSpecServiceDiscovery", "description": "Service discovery information for the virtual node.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackend:VirtualNodeSpecBackend": { "properties": { "virtualService": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualService:VirtualNodeSpecBackendVirtualService", "description": "Virtual service to use as a backend for a virtual node.\n" } }, "type": "object", "required": [ "virtualService" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaults:VirtualNodeSpecBackendDefaults": { "properties": { "clientPolicy": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicy:VirtualNodeSpecBackendDefaultsClientPolicy", "description": "Default client policy for virtual service backends. See above for details.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicy:VirtualNodeSpecBackendDefaultsClientPolicy": { "properties": { "tls": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTls:VirtualNodeSpecBackendDefaultsClientPolicyTls", "description": "Transport Layer Security (TLS) client policy.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTls:VirtualNodeSpecBackendDefaultsClientPolicyTls": { "properties": { "certificate": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificate:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificate", "description": "Listener's TLS certificate.\n" }, "enforce": { "type": "boolean", "description": "Whether the policy is enforced. Default is `true`.\n" }, "ports": { "type": "array", "items": { "type": "integer" }, "description": "One or more ports that the policy is enforced for.\n" }, "validation": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidation:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidation", "description": "Listener's Transport Layer Security (TLS) validation context.\n" } }, "type": "object", "required": [ "validation" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificate:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificate": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateFile:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateFile", "description": "Local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateSds:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateSds", "description": "A [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateFile:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" }, "privateKey": { "type": "string", "description": "Private key for a certificate stored on the file system of the virtual node that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain", "privateKey" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateSds:VirtualNodeSpecBackendDefaultsClientPolicyTlsCertificateSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidation:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidation": { "properties": { "subjectAlternativeNames": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames", "description": "SANs for a TLS validation context.\n" }, "trust": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrust:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrust", "description": "TLS validation context trust.\n" } }, "type": "object", "required": [ "trust" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNames": { "properties": { "match": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch", "description": "Criteria for determining a SAN's match.\n" } }, "type": "object", "required": [ "match" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationSubjectAlternativeNamesMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" }, "description": "Values sent must match the specified values exactly.\n" } }, "type": "object", "required": [ "exacts" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrust:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrust": { "properties": { "acm": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustAcm:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustAcm", "description": "TLS validation context trust for an AWS Certificate Manager (ACM) certificate.\n" }, "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustFile:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustFile", "description": "TLS validation context trust for a local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustSds:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustSds", "description": "TLS validation context trust for a [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustAcm:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" }, "description": "One or more ACM ARNs.\n" } }, "type": "object", "required": [ "certificateAuthorityArns" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustFile:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain" ] }, "aws:appmesh/VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustSds:VirtualNodeSpecBackendDefaultsClientPolicyTlsValidationTrustSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualService:VirtualNodeSpecBackendVirtualService": { "properties": { "clientPolicy": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicy:VirtualNodeSpecBackendVirtualServiceClientPolicy", "description": "Client policy for the backend.\n" }, "virtualServiceName": { "type": "string", "description": "Name of the virtual service that is acting as a virtual node backend. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualServiceName" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicy:VirtualNodeSpecBackendVirtualServiceClientPolicy": { "properties": { "tls": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTls:VirtualNodeSpecBackendVirtualServiceClientPolicyTls", "description": "Transport Layer Security (TLS) client policy.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTls:VirtualNodeSpecBackendVirtualServiceClientPolicyTls": { "properties": { "certificate": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificate:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificate", "description": "Listener's TLS certificate.\n" }, "enforce": { "type": "boolean", "description": "Whether the policy is enforced. Default is `true`.\n" }, "ports": { "type": "array", "items": { "type": "integer" }, "description": "One or more ports that the policy is enforced for.\n" }, "validation": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidation:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidation", "description": "Listener's Transport Layer Security (TLS) validation context.\n" } }, "type": "object", "required": [ "validation" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificate:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificate": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateFile:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateFile", "description": "Local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateSds:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateSds", "description": "A [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateFile:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" }, "privateKey": { "type": "string", "description": "Private key for a certificate stored on the file system of the virtual node that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain", "privateKey" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateSds:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsCertificateSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidation:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidation": { "properties": { "subjectAlternativeNames": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNames:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNames", "description": "SANs for a TLS validation context.\n" }, "trust": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrust:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrust", "description": "TLS validation context trust.\n" } }, "type": "object", "required": [ "trust" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNames:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNames": { "properties": { "match": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNamesMatch", "description": "Criteria for determining a SAN's match.\n" } }, "type": "object", "required": [ "match" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationSubjectAlternativeNamesMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" }, "description": "Values sent must match the specified values exactly.\n" } }, "type": "object", "required": [ "exacts" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrust:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrust": { "properties": { "acm": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustAcm:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustAcm", "description": "TLS validation context trust for an AWS Certificate Manager (ACM) certificate.\n" }, "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustFile:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustFile", "description": "TLS validation context trust for a local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustSds:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustSds", "description": "TLS validation context trust for a [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustAcm:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" }, "description": "One or more ACM ARNs.\n" } }, "type": "object", "required": [ "certificateAuthorityArns" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustFile:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain" ] }, "aws:appmesh/VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustSds:VirtualNodeSpecBackendVirtualServiceClientPolicyTlsValidationTrustSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecListener:VirtualNodeSpecListener": { "properties": { "connectionPool": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerConnectionPool:VirtualNodeSpecListenerConnectionPool", "description": "Connection pool information for the listener.\n" }, "healthCheck": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerHealthCheck:VirtualNodeSpecListenerHealthCheck", "description": "Health check information for the listener.\n" }, "outlierDetection": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerOutlierDetection:VirtualNodeSpecListenerOutlierDetection", "description": "Outlier detection information for the listener.\n" }, "portMapping": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerPortMapping:VirtualNodeSpecListenerPortMapping", "description": "Port mapping information for the listener.\n" }, "timeout": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeout:VirtualNodeSpecListenerTimeout", "description": "Timeouts for different protocols.\n" }, "tls": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTls:VirtualNodeSpecListenerTls", "description": "Transport Layer Security (TLS) properties for the listener\n" } }, "type": "object", "required": [ "portMapping" ] }, "aws:appmesh/VirtualNodeSpecListenerConnectionPool:VirtualNodeSpecListenerConnectionPool": { "properties": { "grpc": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerConnectionPoolGrpc:VirtualNodeSpecListenerConnectionPoolGrpc", "description": "Connection pool information for gRPC listeners.\n" }, "http2s": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerConnectionPoolHttp2:VirtualNodeSpecListenerConnectionPoolHttp2" }, "description": "Connection pool information for HTTP2 listeners.\n" }, "https": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerConnectionPoolHttp:VirtualNodeSpecListenerConnectionPoolHttp" }, "description": "Connection pool information for HTTP listeners.\n" }, "tcps": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerConnectionPoolTcp:VirtualNodeSpecListenerConnectionPoolTcp" }, "description": "Connection pool information for TCP listeners.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerConnectionPoolGrpc:VirtualNodeSpecListenerConnectionPoolGrpc": { "properties": { "maxRequests": { "type": "integer", "description": "Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxRequests" ] }, "aws:appmesh/VirtualNodeSpecListenerConnectionPoolHttp2:VirtualNodeSpecListenerConnectionPoolHttp2": { "properties": { "maxRequests": { "type": "integer", "description": "Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxRequests" ] }, "aws:appmesh/VirtualNodeSpecListenerConnectionPoolHttp:VirtualNodeSpecListenerConnectionPoolHttp": { "properties": { "maxConnections": { "type": "integer", "description": "Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. Minimum value of `1`.\n" }, "maxPendingRequests": { "type": "integer", "description": "Number of overflowing requests after `max_connections` Envoy will queue to upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxConnections" ] }, "aws:appmesh/VirtualNodeSpecListenerConnectionPoolTcp:VirtualNodeSpecListenerConnectionPoolTcp": { "properties": { "maxConnections": { "type": "integer", "description": "Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. Minimum value of `1`.\n" } }, "type": "object", "required": [ "maxConnections" ] }, "aws:appmesh/VirtualNodeSpecListenerHealthCheck:VirtualNodeSpecListenerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer", "description": "Number of consecutive successful health checks that must occur before declaring listener healthy.\n" }, "intervalMillis": { "type": "integer", "description": "Time period in milliseconds between each health check execution.\n" }, "path": { "type": "string", "description": "Destination path for the health check request. This is only required if the specified protocol is `http` or `http2`.\n" }, "port": { "type": "integer", "description": "Destination port for the health check request. This port must match the port defined in the `port_mapping` for the listener.\n" }, "protocol": { "type": "string", "description": "Protocol for the health check request. Valid values are `http`, `http2`, `tcp` and `grpc`.\n" }, "timeoutMillis": { "type": "integer", "description": "Amount of time to wait when receiving a response from the health check, in milliseconds.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.\n" } }, "type": "object", "required": [ "healthyThreshold", "intervalMillis", "protocol", "timeoutMillis", "unhealthyThreshold" ], "language": { "nodejs": { "requiredOutputs": [ "healthyThreshold", "intervalMillis", "port", "protocol", "timeoutMillis", "unhealthyThreshold" ] } } }, "aws:appmesh/VirtualNodeSpecListenerOutlierDetection:VirtualNodeSpecListenerOutlierDetection": { "properties": { "baseEjectionDuration": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration:VirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration", "description": "Base amount of time for which a host is ejected.\n" }, "interval": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerOutlierDetectionInterval:VirtualNodeSpecListenerOutlierDetectionInterval", "description": "Time interval between ejection sweep analysis.\n" }, "maxEjectionPercent": { "type": "integer", "description": "Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.\nMinimum value of `0`. Maximum value of `100`.\n" }, "maxServerErrors": { "type": "integer", "description": "Number of consecutive `5xx` errors required for ejection. Minimum value of `1`.\n" } }, "type": "object", "required": [ "baseEjectionDuration", "interval", "maxEjectionPercent", "maxServerErrors" ] }, "aws:appmesh/VirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration:VirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerOutlierDetectionInterval:VirtualNodeSpecListenerOutlierDetectionInterval": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerPortMapping:VirtualNodeSpecListenerPortMapping": { "properties": { "port": { "type": "integer", "description": "Port used for the port mapping.\n" }, "protocol": { "type": "string", "description": "Protocol used for the port mapping. Valid values are `http`, `http2`, `tcp` and `grpc`.\n" } }, "type": "object", "required": [ "port", "protocol" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeout:VirtualNodeSpecListenerTimeout": { "properties": { "grpc": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutGrpc:VirtualNodeSpecListenerTimeoutGrpc", "description": "Timeouts for gRPC listeners.\n" }, "http": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttp:VirtualNodeSpecListenerTimeoutHttp", "description": "Timeouts for HTTP listeners.\n" }, "http2": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2:VirtualNodeSpecListenerTimeoutHttp2", "description": "Timeouts for HTTP2 listeners.\n" }, "tcp": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutTcp:VirtualNodeSpecListenerTimeoutTcp", "description": "Timeouts for TCP listeners.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTimeoutGrpc:VirtualNodeSpecListenerTimeoutGrpc": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutGrpcIdle:VirtualNodeSpecListenerTimeoutGrpcIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutGrpcPerRequest:VirtualNodeSpecListenerTimeoutGrpcPerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTimeoutGrpcIdle:VirtualNodeSpecListenerTimeoutGrpcIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutGrpcPerRequest:VirtualNodeSpecListenerTimeoutGrpcPerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2:VirtualNodeSpecListenerTimeoutHttp2": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2Idle:VirtualNodeSpecListenerTimeoutHttp2Idle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2PerRequest:VirtualNodeSpecListenerTimeoutHttp2PerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2Idle:VirtualNodeSpecListenerTimeoutHttp2Idle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttp2PerRequest:VirtualNodeSpecListenerTimeoutHttp2PerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttp:VirtualNodeSpecListenerTimeoutHttp": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttpIdle:VirtualNodeSpecListenerTimeoutHttpIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" }, "perRequest": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutHttpPerRequest:VirtualNodeSpecListenerTimeoutHttpPerRequest", "description": "Per request timeout.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttpIdle:VirtualNodeSpecListenerTimeoutHttpIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutHttpPerRequest:VirtualNodeSpecListenerTimeoutHttpPerRequest": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTimeoutTcp:VirtualNodeSpecListenerTimeoutTcp": { "properties": { "idle": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTimeoutTcpIdle:VirtualNodeSpecListenerTimeoutTcpIdle", "description": "Idle timeout. An idle timeout bounds the amount of time that a connection may be idle.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTimeoutTcpIdle:VirtualNodeSpecListenerTimeoutTcpIdle": { "properties": { "unit": { "type": "string", "description": "Unit of time. Valid values: `ms`, `s`.\n" }, "value": { "type": "integer", "description": "Number of time units. Minimum value of `0`.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:appmesh/VirtualNodeSpecListenerTls:VirtualNodeSpecListenerTls": { "properties": { "certificate": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsCertificate:VirtualNodeSpecListenerTlsCertificate", "description": "Listener's TLS certificate.\n" }, "mode": { "type": "string", "description": "Listener's TLS mode. Valid values: `DISABLED`, `PERMISSIVE`, `STRICT`.\n" }, "validation": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidation:VirtualNodeSpecListenerTlsValidation", "description": "Listener's Transport Layer Security (TLS) validation context.\n" } }, "type": "object", "required": [ "certificate", "mode" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsCertificate:VirtualNodeSpecListenerTlsCertificate": { "properties": { "acm": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsCertificateAcm:VirtualNodeSpecListenerTlsCertificateAcm", "description": "An AWS Certificate Manager (ACM) certificate.\n" }, "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsCertificateFile:VirtualNodeSpecListenerTlsCertificateFile", "description": "Local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsCertificateSds:VirtualNodeSpecListenerTlsCertificateSds", "description": "A [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTlsCertificateAcm:VirtualNodeSpecListenerTlsCertificateAcm": { "properties": { "certificateArn": { "type": "string", "description": "ARN for the certificate.\n" } }, "type": "object", "required": [ "certificateArn" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsCertificateFile:VirtualNodeSpecListenerTlsCertificateFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" }, "privateKey": { "type": "string", "description": "Private key for a certificate stored on the file system of the virtual node that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain", "privateKey" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsCertificateSds:VirtualNodeSpecListenerTlsCertificateSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsValidation:VirtualNodeSpecListenerTlsValidation": { "properties": { "subjectAlternativeNames": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidationSubjectAlternativeNames:VirtualNodeSpecListenerTlsValidationSubjectAlternativeNames", "description": "SANs for a TLS validation context.\n" }, "trust": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidationTrust:VirtualNodeSpecListenerTlsValidationTrust", "description": "TLS validation context trust.\n" } }, "type": "object", "required": [ "trust" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsValidationSubjectAlternativeNames:VirtualNodeSpecListenerTlsValidationSubjectAlternativeNames": { "properties": { "match": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecListenerTlsValidationSubjectAlternativeNamesMatch", "description": "Criteria for determining a SAN's match.\n" } }, "type": "object", "required": [ "match" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsValidationSubjectAlternativeNamesMatch:VirtualNodeSpecListenerTlsValidationSubjectAlternativeNamesMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" }, "description": "Values sent must match the specified values exactly.\n" } }, "type": "object", "required": [ "exacts" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsValidationTrust:VirtualNodeSpecListenerTlsValidationTrust": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidationTrustFile:VirtualNodeSpecListenerTlsValidationTrustFile", "description": "TLS validation context trust for a local file certificate.\n" }, "sds": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecListenerTlsValidationTrustSds:VirtualNodeSpecListenerTlsValidationTrustSds", "description": "TLS validation context trust for a [Secret Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/security/secret#secret-discovery-service-sds) certificate.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecListenerTlsValidationTrustFile:VirtualNodeSpecListenerTlsValidationTrustFile": { "properties": { "certificateChain": { "type": "string", "description": "Certificate trust chain for a certificate stored on the file system of the mesh endpoint that the proxy is running on. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "certificateChain" ] }, "aws:appmesh/VirtualNodeSpecListenerTlsValidationTrustSds:VirtualNodeSpecListenerTlsValidationTrustSds": { "properties": { "secretName": { "type": "string", "description": "Name of the secret for a virtual node's Transport Layer Security (TLS) Secret Discovery Service validation context trust.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:appmesh/VirtualNodeSpecLogging:VirtualNodeSpecLogging": { "properties": { "accessLog": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecLoggingAccessLog:VirtualNodeSpecLoggingAccessLog", "description": "Access log configuration for a virtual node.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecLoggingAccessLog:VirtualNodeSpecLoggingAccessLog": { "properties": { "file": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecLoggingAccessLogFile:VirtualNodeSpecLoggingAccessLogFile", "description": "File object to send virtual node access logs to.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecLoggingAccessLogFile:VirtualNodeSpecLoggingAccessLogFile": { "properties": { "format": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecLoggingAccessLogFileFormat:VirtualNodeSpecLoggingAccessLogFileFormat", "description": "The specified format for the logs.\n" }, "path": { "type": "string", "description": "File path to write access logs to. You can use `/dev/stdout` to send access logs to standard out. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "path" ] }, "aws:appmesh/VirtualNodeSpecLoggingAccessLogFileFormat:VirtualNodeSpecLoggingAccessLogFileFormat": { "properties": { "jsons": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecLoggingAccessLogFileFormatJson:VirtualNodeSpecLoggingAccessLogFileFormatJson" }, "description": "The logging format for JSON.\n" }, "text": { "type": "string", "description": "The logging format for text. Must be between 1 and 1000 characters in length.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecLoggingAccessLogFileFormatJson:VirtualNodeSpecLoggingAccessLogFileFormatJson": { "properties": { "key": { "type": "string", "description": "The specified key for the JSON. Must be between 1 and 100 characters in length.\n" }, "value": { "type": "string", "description": "The specified value for the JSON. Must be between 1 and 100 characters in length.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:appmesh/VirtualNodeSpecServiceDiscovery:VirtualNodeSpecServiceDiscovery": { "properties": { "awsCloudMap": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecServiceDiscoveryAwsCloudMap:VirtualNodeSpecServiceDiscoveryAwsCloudMap", "description": "Any AWS Cloud Map information for the virtual node.\n" }, "dns": { "$ref": "#/types/aws:appmesh/VirtualNodeSpecServiceDiscoveryDns:VirtualNodeSpecServiceDiscoveryDns", "description": "DNS service name for the virtual node.\n" } }, "type": "object" }, "aws:appmesh/VirtualNodeSpecServiceDiscoveryAwsCloudMap:VirtualNodeSpecServiceDiscoveryAwsCloudMap": { "properties": { "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "String map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.\n" }, "namespaceName": { "type": "string", "description": "Name of the AWS Cloud Map namespace to use.\nUse the `aws.servicediscovery.HttpNamespace` resource to configure a Cloud Map namespace. Must be between 1 and 1024 characters in length.\n" }, "serviceName": { "type": "string", "description": "Name of the AWS Cloud Map service to use. Use the `aws.servicediscovery.Service` resource to configure a Cloud Map service. Must be between 1 and 1024 characters in length.\n" } }, "type": "object", "required": [ "namespaceName", "serviceName" ] }, "aws:appmesh/VirtualNodeSpecServiceDiscoveryDns:VirtualNodeSpecServiceDiscoveryDns": { "properties": { "hostname": { "type": "string", "description": "DNS host name for your virtual node.\n" }, "ipPreference": { "type": "string", "description": "The preferred IP version that this virtual node uses. Valid values: `IPv6_PREFERRED`, `IPv4_PREFERRED`, `IPv4_ONLY`, `IPv6_ONLY`.\n" }, "responseType": { "type": "string", "description": "The DNS response type for the virtual node. Valid values: `LOADBALANCER`, `ENDPOINTS`.\n" } }, "type": "object", "required": [ "hostname" ] }, "aws:appmesh/VirtualRouterSpec:VirtualRouterSpec": { "properties": { "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/VirtualRouterSpecListener:VirtualRouterSpecListener" }, "description": "Listeners that the virtual router is expected to receive inbound traffic from.\nCurrently only one listener is supported per virtual router.\n" } }, "type": "object" }, "aws:appmesh/VirtualRouterSpecListener:VirtualRouterSpecListener": { "properties": { "portMapping": { "$ref": "#/types/aws:appmesh/VirtualRouterSpecListenerPortMapping:VirtualRouterSpecListenerPortMapping", "description": "Port mapping information for the listener.\n" } }, "type": "object", "required": [ "portMapping" ] }, "aws:appmesh/VirtualRouterSpecListenerPortMapping:VirtualRouterSpecListenerPortMapping": { "properties": { "port": { "type": "integer", "description": "Port used for the port mapping.\n" }, "protocol": { "type": "string", "description": "Protocol used for the port mapping. Valid values are `http`,`http2`, `tcp` and `grpc`.\n" } }, "type": "object", "required": [ "port", "protocol" ] }, "aws:appmesh/VirtualServiceSpec:VirtualServiceSpec": { "properties": { "provider": { "$ref": "#/types/aws:appmesh/VirtualServiceSpecProvider:VirtualServiceSpecProvider", "description": "App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.\n" } }, "type": "object" }, "aws:appmesh/VirtualServiceSpecProvider:VirtualServiceSpecProvider": { "properties": { "virtualNode": { "$ref": "#/types/aws:appmesh/VirtualServiceSpecProviderVirtualNode:VirtualServiceSpecProviderVirtualNode", "description": "Virtual node associated with a virtual service.\n" }, "virtualRouter": { "$ref": "#/types/aws:appmesh/VirtualServiceSpecProviderVirtualRouter:VirtualServiceSpecProviderVirtualRouter", "description": "Virtual router associated with a virtual service.\n" } }, "type": "object" }, "aws:appmesh/VirtualServiceSpecProviderVirtualNode:VirtualServiceSpecProviderVirtualNode": { "properties": { "virtualNodeName": { "type": "string", "description": "Name of the virtual node that is acting as a service provider. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualNodeName" ] }, "aws:appmesh/VirtualServiceSpecProviderVirtualRouter:VirtualServiceSpecProviderVirtualRouter": { "properties": { "virtualRouterName": { "type": "string", "description": "Name of the virtual router that is acting as a service provider. Must be between 1 and 255 characters in length.\n" } }, "type": "object", "required": [ "virtualRouterName" ] }, "aws:appmesh/getGatewayRouteSpec:getGatewayRouteSpec": { "properties": { "grpcRoutes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecGrpcRoute:getGatewayRouteSpecGrpcRoute" } }, "http2Routes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2Route:getGatewayRouteSpecHttp2Route" } }, "httpRoutes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRoute:getGatewayRouteSpecHttpRoute" } }, "priority": { "type": "integer" } }, "type": "object", "required": [ "grpcRoutes", "http2Routes", "httpRoutes", "priority" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecGrpcRoute:getGatewayRouteSpecGrpcRoute": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecGrpcRouteAction:getGatewayRouteSpecGrpcRouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecGrpcRouteMatch:getGatewayRouteSpecGrpcRouteMatch" } } }, "type": "object", "required": [ "actions", "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecGrpcRouteAction:getGatewayRouteSpecGrpcRouteAction": { "properties": { "targets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecGrpcRouteActionTarget:getGatewayRouteSpecGrpcRouteActionTarget" } } }, "type": "object", "required": [ "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecGrpcRouteActionTarget:getGatewayRouteSpecGrpcRouteActionTarget": { "properties": { "port": { "type": "integer" }, "virtualServices": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecGrpcRouteActionTargetVirtualService:getGatewayRouteSpecGrpcRouteActionTargetVirtualService" } } }, "type": "object", "required": [ "port", "virtualServices" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecGrpcRouteActionTargetVirtualService:getGatewayRouteSpecGrpcRouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string" } }, "type": "object", "required": [ "virtualServiceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecGrpcRouteMatch:getGatewayRouteSpecGrpcRouteMatch": { "properties": { "port": { "type": "integer" }, "serviceName": { "type": "string" } }, "type": "object", "required": [ "port", "serviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2Route:getGatewayRouteSpecHttp2Route": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteAction:getGatewayRouteSpecHttp2RouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatch:getGatewayRouteSpecHttp2RouteMatch" } } }, "type": "object", "required": [ "actions", "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteAction:getGatewayRouteSpecHttp2RouteAction": { "properties": { "rewrites": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewrite:getGatewayRouteSpecHttp2RouteActionRewrite" } }, "targets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionTarget:getGatewayRouteSpecHttp2RouteActionTarget" } } }, "type": "object", "required": [ "rewrites", "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewrite:getGatewayRouteSpecHttp2RouteActionRewrite": { "properties": { "hostnames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewriteHostname:getGatewayRouteSpecHttp2RouteActionRewriteHostname" } }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewritePath:getGatewayRouteSpecHttp2RouteActionRewritePath" } }, "prefixes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewritePrefix:getGatewayRouteSpecHttp2RouteActionRewritePrefix" } } }, "type": "object", "required": [ "hostnames", "paths", "prefixes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewriteHostname:getGatewayRouteSpecHttp2RouteActionRewriteHostname": { "properties": { "defaultTargetHostname": { "type": "string" } }, "type": "object", "required": [ "defaultTargetHostname" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewritePath:getGatewayRouteSpecHttp2RouteActionRewritePath": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionRewritePrefix:getGatewayRouteSpecHttp2RouteActionRewritePrefix": { "properties": { "defaultPrefix": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "defaultPrefix", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionTarget:getGatewayRouteSpecHttp2RouteActionTarget": { "properties": { "port": { "type": "integer" }, "virtualServices": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteActionTargetVirtualService:getGatewayRouteSpecHttp2RouteActionTargetVirtualService" } } }, "type": "object", "required": [ "port", "virtualServices" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteActionTargetVirtualService:getGatewayRouteSpecHttp2RouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string" } }, "type": "object", "required": [ "virtualServiceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatch:getGatewayRouteSpecHttp2RouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeader:getGatewayRouteSpecHttp2RouteMatchHeader" } }, "hostnames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHostname:getGatewayRouteSpecHttp2RouteMatchHostname" } }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchPath:getGatewayRouteSpecHttp2RouteMatchPath" } }, "port": { "type": "integer" }, "prefix": { "type": "string" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchQueryParameter:getGatewayRouteSpecHttp2RouteMatchQueryParameter" } } }, "type": "object", "required": [ "headers", "hostnames", "paths", "port", "prefix", "queryParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeader:getGatewayRouteSpecHttp2RouteMatchHeader": { "properties": { "invert": { "type": "boolean" }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeaderMatch:getGatewayRouteSpecHttp2RouteMatchHeaderMatch" } }, "name": { "type": "string", "description": "Name of the gateway route.\n" } }, "type": "object", "required": [ "invert", "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeaderMatch:getGatewayRouteSpecHttp2RouteMatchHeaderMatch": { "properties": { "exact": { "type": "string" }, "prefix": { "type": "string" }, "ranges": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeaderMatchRange:getGatewayRouteSpecHttp2RouteMatchHeaderMatchRange" } }, "regex": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "prefix", "ranges", "regex", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHeaderMatchRange:getGatewayRouteSpecHttp2RouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } }, "type": "object", "required": [ "end", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchHostname:getGatewayRouteSpecHttp2RouteMatchHostname": { "properties": { "exact": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchPath:getGatewayRouteSpecHttp2RouteMatchPath": { "properties": { "exact": { "type": "string" }, "regex": { "type": "string" } }, "type": "object", "required": [ "exact", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchQueryParameter:getGatewayRouteSpecHttp2RouteMatchQueryParameter": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttp2RouteMatchQueryParameterMatch:getGatewayRouteSpecHttp2RouteMatchQueryParameterMatch" } }, "name": { "type": "string", "description": "Name of the gateway route.\n" } }, "type": "object", "required": [ "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttp2RouteMatchQueryParameterMatch:getGatewayRouteSpecHttp2RouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRoute:getGatewayRouteSpecHttpRoute": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteAction:getGatewayRouteSpecHttpRouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatch:getGatewayRouteSpecHttpRouteMatch" } } }, "type": "object", "required": [ "actions", "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteAction:getGatewayRouteSpecHttpRouteAction": { "properties": { "rewrites": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionRewrite:getGatewayRouteSpecHttpRouteActionRewrite" } }, "targets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionTarget:getGatewayRouteSpecHttpRouteActionTarget" } } }, "type": "object", "required": [ "rewrites", "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionRewrite:getGatewayRouteSpecHttpRouteActionRewrite": { "properties": { "hostnames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionRewriteHostname:getGatewayRouteSpecHttpRouteActionRewriteHostname" } }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionRewritePath:getGatewayRouteSpecHttpRouteActionRewritePath" } }, "prefixes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionRewritePrefix:getGatewayRouteSpecHttpRouteActionRewritePrefix" } } }, "type": "object", "required": [ "hostnames", "paths", "prefixes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionRewriteHostname:getGatewayRouteSpecHttpRouteActionRewriteHostname": { "properties": { "defaultTargetHostname": { "type": "string" } }, "type": "object", "required": [ "defaultTargetHostname" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionRewritePath:getGatewayRouteSpecHttpRouteActionRewritePath": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionRewritePrefix:getGatewayRouteSpecHttpRouteActionRewritePrefix": { "properties": { "defaultPrefix": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "defaultPrefix", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionTarget:getGatewayRouteSpecHttpRouteActionTarget": { "properties": { "port": { "type": "integer" }, "virtualServices": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteActionTargetVirtualService:getGatewayRouteSpecHttpRouteActionTargetVirtualService" } } }, "type": "object", "required": [ "port", "virtualServices" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteActionTargetVirtualService:getGatewayRouteSpecHttpRouteActionTargetVirtualService": { "properties": { "virtualServiceName": { "type": "string" } }, "type": "object", "required": [ "virtualServiceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatch:getGatewayRouteSpecHttpRouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeader:getGatewayRouteSpecHttpRouteMatchHeader" } }, "hostnames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchHostname:getGatewayRouteSpecHttpRouteMatchHostname" } }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchPath:getGatewayRouteSpecHttpRouteMatchPath" } }, "port": { "type": "integer" }, "prefix": { "type": "string" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchQueryParameter:getGatewayRouteSpecHttpRouteMatchQueryParameter" } } }, "type": "object", "required": [ "headers", "hostnames", "paths", "port", "prefix", "queryParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeader:getGatewayRouteSpecHttpRouteMatchHeader": { "properties": { "invert": { "type": "boolean" }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeaderMatch:getGatewayRouteSpecHttpRouteMatchHeaderMatch" } }, "name": { "type": "string", "description": "Name of the gateway route.\n" } }, "type": "object", "required": [ "invert", "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeaderMatch:getGatewayRouteSpecHttpRouteMatchHeaderMatch": { "properties": { "exact": { "type": "string" }, "prefix": { "type": "string" }, "ranges": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeaderMatchRange:getGatewayRouteSpecHttpRouteMatchHeaderMatchRange" } }, "regex": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "prefix", "ranges", "regex", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchHeaderMatchRange:getGatewayRouteSpecHttpRouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } }, "type": "object", "required": [ "end", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchHostname:getGatewayRouteSpecHttpRouteMatchHostname": { "properties": { "exact": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchPath:getGatewayRouteSpecHttpRouteMatchPath": { "properties": { "exact": { "type": "string" }, "regex": { "type": "string" } }, "type": "object", "required": [ "exact", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchQueryParameter:getGatewayRouteSpecHttpRouteMatchQueryParameter": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getGatewayRouteSpecHttpRouteMatchQueryParameterMatch:getGatewayRouteSpecHttpRouteMatchQueryParameterMatch" } }, "name": { "type": "string", "description": "Name of the gateway route.\n" } }, "type": "object", "required": [ "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getGatewayRouteSpecHttpRouteMatchQueryParameterMatch:getGatewayRouteSpecHttpRouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getMeshSpec:getMeshSpec": { "properties": { "egressFilters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getMeshSpecEgressFilter:getMeshSpecEgressFilter" } }, "serviceDiscoveries": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getMeshSpecServiceDiscovery:getMeshSpecServiceDiscovery" } } }, "type": "object", "required": [ "egressFilters", "serviceDiscoveries" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getMeshSpecEgressFilter:getMeshSpecEgressFilter": { "properties": { "type": { "type": "string" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getMeshSpecServiceDiscovery:getMeshSpecServiceDiscovery": { "properties": { "ipPreference": { "type": "string" } }, "type": "object", "required": [ "ipPreference" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpec:getRouteSpec": { "properties": { "grpcRoutes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRoute:getRouteSpecGrpcRoute" } }, "http2Routes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2Route:getRouteSpecHttp2Route" } }, "httpRoutes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRoute:getRouteSpecHttpRoute" } }, "priority": { "type": "integer" }, "tcpRoutes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRoute:getRouteSpecTcpRoute" } } }, "type": "object", "required": [ "grpcRoutes", "http2Routes", "httpRoutes", "priority", "tcpRoutes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRoute:getRouteSpecGrpcRoute": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteAction:getRouteSpecGrpcRouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteMatch:getRouteSpecGrpcRouteMatch" } }, "retryPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteRetryPolicy:getRouteSpecGrpcRouteRetryPolicy" } }, "timeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteTimeout:getRouteSpecGrpcRouteTimeout" } } }, "type": "object", "required": [ "actions", "matches", "retryPolicies", "timeouts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteAction:getRouteSpecGrpcRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteActionWeightedTarget:getRouteSpecGrpcRouteActionWeightedTarget" } } }, "type": "object", "required": [ "weightedTargets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteActionWeightedTarget:getRouteSpecGrpcRouteActionWeightedTarget": { "properties": { "port": { "type": "integer" }, "virtualNode": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "port", "virtualNode", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteMatch:getRouteSpecGrpcRouteMatch": { "properties": { "metadatas": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteMatchMetadata:getRouteSpecGrpcRouteMatchMetadata" } }, "methodName": { "type": "string" }, "port": { "type": "integer" }, "prefix": { "type": "string" }, "serviceName": { "type": "string" } }, "type": "object", "required": [ "metadatas", "methodName", "port", "prefix", "serviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteMatchMetadata:getRouteSpecGrpcRouteMatchMetadata": { "properties": { "invert": { "type": "boolean" }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteMatchMetadataMatch:getRouteSpecGrpcRouteMatchMetadataMatch" } }, "name": { "type": "string", "description": "Name of the route.\n" } }, "type": "object", "required": [ "invert", "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteMatchMetadataMatch:getRouteSpecGrpcRouteMatchMetadataMatch": { "properties": { "exact": { "type": "string" }, "prefix": { "type": "string" }, "ranges": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteMatchMetadataMatchRange:getRouteSpecGrpcRouteMatchMetadataMatchRange" } }, "regex": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "prefix", "ranges", "regex", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteMatchMetadataMatchRange:getRouteSpecGrpcRouteMatchMetadataMatchRange": { "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } }, "type": "object", "required": [ "end", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteRetryPolicy:getRouteSpecGrpcRouteRetryPolicy": { "properties": { "grpcRetryEvents": { "type": "array", "items": { "type": "string" } }, "httpRetryEvents": { "type": "array", "items": { "type": "string" } }, "maxRetries": { "type": "integer" }, "perRetryTimeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteRetryPolicyPerRetryTimeout:getRouteSpecGrpcRouteRetryPolicyPerRetryTimeout" } }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "grpcRetryEvents", "httpRetryEvents", "maxRetries", "perRetryTimeouts", "tcpRetryEvents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteRetryPolicyPerRetryTimeout:getRouteSpecGrpcRouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteTimeout:getRouteSpecGrpcRouteTimeout": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteTimeoutIdle:getRouteSpecGrpcRouteTimeoutIdle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecGrpcRouteTimeoutPerRequest:getRouteSpecGrpcRouteTimeoutPerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteTimeoutIdle:getRouteSpecGrpcRouteTimeoutIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecGrpcRouteTimeoutPerRequest:getRouteSpecGrpcRouteTimeoutPerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2Route:getRouteSpecHttp2Route": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteAction:getRouteSpecHttp2RouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatch:getRouteSpecHttp2RouteMatch" } }, "retryPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteRetryPolicy:getRouteSpecHttp2RouteRetryPolicy" } }, "timeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteTimeout:getRouteSpecHttp2RouteTimeout" } } }, "type": "object", "required": [ "actions", "matches", "retryPolicies", "timeouts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteAction:getRouteSpecHttp2RouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteActionWeightedTarget:getRouteSpecHttp2RouteActionWeightedTarget" } } }, "type": "object", "required": [ "weightedTargets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteActionWeightedTarget:getRouteSpecHttp2RouteActionWeightedTarget": { "properties": { "port": { "type": "integer" }, "virtualNode": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "port", "virtualNode", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatch:getRouteSpecHttp2RouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchHeader:getRouteSpecHttp2RouteMatchHeader" } }, "method": { "type": "string" }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchPath:getRouteSpecHttp2RouteMatchPath" } }, "port": { "type": "integer" }, "prefix": { "type": "string" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchQueryParameter:getRouteSpecHttp2RouteMatchQueryParameter" } }, "scheme": { "type": "string" } }, "type": "object", "required": [ "headers", "method", "paths", "port", "prefix", "queryParameters", "scheme" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchHeader:getRouteSpecHttp2RouteMatchHeader": { "properties": { "invert": { "type": "boolean" }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchHeaderMatch:getRouteSpecHttp2RouteMatchHeaderMatch" } }, "name": { "type": "string", "description": "Name of the route.\n" } }, "type": "object", "required": [ "invert", "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchHeaderMatch:getRouteSpecHttp2RouteMatchHeaderMatch": { "properties": { "exact": { "type": "string" }, "prefix": { "type": "string" }, "ranges": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchHeaderMatchRange:getRouteSpecHttp2RouteMatchHeaderMatchRange" } }, "regex": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "prefix", "ranges", "regex", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchHeaderMatchRange:getRouteSpecHttp2RouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } }, "type": "object", "required": [ "end", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchPath:getRouteSpecHttp2RouteMatchPath": { "properties": { "exact": { "type": "string" }, "regex": { "type": "string" } }, "type": "object", "required": [ "exact", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchQueryParameter:getRouteSpecHttp2RouteMatchQueryParameter": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteMatchQueryParameterMatch:getRouteSpecHttp2RouteMatchQueryParameterMatch" } }, "name": { "type": "string", "description": "Name of the route.\n" } }, "type": "object", "required": [ "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteMatchQueryParameterMatch:getRouteSpecHttp2RouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteRetryPolicy:getRouteSpecHttp2RouteRetryPolicy": { "properties": { "httpRetryEvents": { "type": "array", "items": { "type": "string" } }, "maxRetries": { "type": "integer" }, "perRetryTimeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteRetryPolicyPerRetryTimeout:getRouteSpecHttp2RouteRetryPolicyPerRetryTimeout" } }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "httpRetryEvents", "maxRetries", "perRetryTimeouts", "tcpRetryEvents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteRetryPolicyPerRetryTimeout:getRouteSpecHttp2RouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteTimeout:getRouteSpecHttp2RouteTimeout": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteTimeoutIdle:getRouteSpecHttp2RouteTimeoutIdle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttp2RouteTimeoutPerRequest:getRouteSpecHttp2RouteTimeoutPerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteTimeoutIdle:getRouteSpecHttp2RouteTimeoutIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttp2RouteTimeoutPerRequest:getRouteSpecHttp2RouteTimeoutPerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRoute:getRouteSpecHttpRoute": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteAction:getRouteSpecHttpRouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatch:getRouteSpecHttpRouteMatch" } }, "retryPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteRetryPolicy:getRouteSpecHttpRouteRetryPolicy" } }, "timeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteTimeout:getRouteSpecHttpRouteTimeout" } } }, "type": "object", "required": [ "actions", "matches", "retryPolicies", "timeouts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteAction:getRouteSpecHttpRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteActionWeightedTarget:getRouteSpecHttpRouteActionWeightedTarget" } } }, "type": "object", "required": [ "weightedTargets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteActionWeightedTarget:getRouteSpecHttpRouteActionWeightedTarget": { "properties": { "port": { "type": "integer" }, "virtualNode": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "port", "virtualNode", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatch:getRouteSpecHttpRouteMatch": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchHeader:getRouteSpecHttpRouteMatchHeader" } }, "method": { "type": "string" }, "paths": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchPath:getRouteSpecHttpRouteMatchPath" } }, "port": { "type": "integer" }, "prefix": { "type": "string" }, "queryParameters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchQueryParameter:getRouteSpecHttpRouteMatchQueryParameter" } }, "scheme": { "type": "string" } }, "type": "object", "required": [ "headers", "method", "paths", "port", "prefix", "queryParameters", "scheme" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchHeader:getRouteSpecHttpRouteMatchHeader": { "properties": { "invert": { "type": "boolean" }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchHeaderMatch:getRouteSpecHttpRouteMatchHeaderMatch" } }, "name": { "type": "string", "description": "Name of the route.\n" } }, "type": "object", "required": [ "invert", "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchHeaderMatch:getRouteSpecHttpRouteMatchHeaderMatch": { "properties": { "exact": { "type": "string" }, "prefix": { "type": "string" }, "ranges": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchHeaderMatchRange:getRouteSpecHttpRouteMatchHeaderMatchRange" } }, "regex": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "exact", "prefix", "ranges", "regex", "suffix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchHeaderMatchRange:getRouteSpecHttpRouteMatchHeaderMatchRange": { "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } }, "type": "object", "required": [ "end", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchPath:getRouteSpecHttpRouteMatchPath": { "properties": { "exact": { "type": "string" }, "regex": { "type": "string" } }, "type": "object", "required": [ "exact", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchQueryParameter:getRouteSpecHttpRouteMatchQueryParameter": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteMatchQueryParameterMatch:getRouteSpecHttpRouteMatchQueryParameterMatch" } }, "name": { "type": "string", "description": "Name of the route.\n" } }, "type": "object", "required": [ "matches", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteMatchQueryParameterMatch:getRouteSpecHttpRouteMatchQueryParameterMatch": { "properties": { "exact": { "type": "string" } }, "type": "object", "required": [ "exact" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteRetryPolicy:getRouteSpecHttpRouteRetryPolicy": { "properties": { "httpRetryEvents": { "type": "array", "items": { "type": "string" } }, "maxRetries": { "type": "integer" }, "perRetryTimeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteRetryPolicyPerRetryTimeout:getRouteSpecHttpRouteRetryPolicyPerRetryTimeout" } }, "tcpRetryEvents": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "httpRetryEvents", "maxRetries", "perRetryTimeouts", "tcpRetryEvents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteRetryPolicyPerRetryTimeout:getRouteSpecHttpRouteRetryPolicyPerRetryTimeout": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteTimeout:getRouteSpecHttpRouteTimeout": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteTimeoutIdle:getRouteSpecHttpRouteTimeoutIdle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecHttpRouteTimeoutPerRequest:getRouteSpecHttpRouteTimeoutPerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteTimeoutIdle:getRouteSpecHttpRouteTimeoutIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecHttpRouteTimeoutPerRequest:getRouteSpecHttpRouteTimeoutPerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRoute:getRouteSpecTcpRoute": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRouteAction:getRouteSpecTcpRouteAction" } }, "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRouteMatch:getRouteSpecTcpRouteMatch" } }, "timeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRouteTimeout:getRouteSpecTcpRouteTimeout" } } }, "type": "object", "required": [ "actions", "matches", "timeouts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRouteAction:getRouteSpecTcpRouteAction": { "properties": { "weightedTargets": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRouteActionWeightedTarget:getRouteSpecTcpRouteActionWeightedTarget" } } }, "type": "object", "required": [ "weightedTargets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRouteActionWeightedTarget:getRouteSpecTcpRouteActionWeightedTarget": { "properties": { "port": { "type": "integer" }, "virtualNode": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "port", "virtualNode", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRouteMatch:getRouteSpecTcpRouteMatch": { "properties": { "port": { "type": "integer" } }, "type": "object", "required": [ "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRouteTimeout:getRouteSpecTcpRouteTimeout": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getRouteSpecTcpRouteTimeoutIdle:getRouteSpecTcpRouteTimeoutIdle" } } }, "type": "object", "required": [ "idles" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getRouteSpecTcpRouteTimeoutIdle:getRouteSpecTcpRouteTimeoutIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpec:getVirtualGatewaySpec": { "properties": { "backendDefaults": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefault:getVirtualGatewaySpecBackendDefault" } }, "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListener:getVirtualGatewaySpecListener" } }, "loggings": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecLogging:getVirtualGatewaySpecLogging" } } }, "type": "object", "required": [ "backendDefaults", "listeners", "loggings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefault:getVirtualGatewaySpecBackendDefault": { "properties": { "clientPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicy:getVirtualGatewaySpecBackendDefaultClientPolicy" } } }, "type": "object", "required": [ "clientPolicies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicy:getVirtualGatewaySpecBackendDefaultClientPolicy": { "properties": { "tls": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTl:getVirtualGatewaySpecBackendDefaultClientPolicyTl" } } }, "type": "object", "required": [ "tls" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTl:getVirtualGatewaySpecBackendDefaultClientPolicyTl": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificate:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificate" } }, "enforce": { "type": "boolean" }, "ports": { "type": "array", "items": { "type": "integer" } }, "validations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidation:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidation" } } }, "type": "object", "required": [ "certificates", "enforce", "ports", "validations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificate:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificate": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateFile:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateSd:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateSd" } } }, "type": "object", "required": [ "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateFile:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateFile": { "properties": { "certificateChain": { "type": "string" }, "privateKey": { "type": "string" } }, "type": "object", "required": [ "certificateChain", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateSd:getVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidation:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidation": { "properties": { "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName" } }, "trusts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrust:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrust" } } }, "type": "object", "required": [ "subjectAlternativeNames", "trusts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch" } } }, "type": "object", "required": [ "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "exacts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrust:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrust": { "properties": { "acms": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustAcm:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustAcm" } }, "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustFile:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustSd:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustSd" } } }, "type": "object", "required": [ "acms", "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustAcm:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "certificateAuthorityArns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustFile:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustFile": { "properties": { "certificateChain": { "type": "string" } }, "type": "object", "required": [ "certificateChain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustSd:getVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListener:getVirtualGatewaySpecListener": { "properties": { "connectionPools": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerConnectionPool:getVirtualGatewaySpecListenerConnectionPool" } }, "healthChecks": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerHealthCheck:getVirtualGatewaySpecListenerHealthCheck" } }, "portMappings": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerPortMapping:getVirtualGatewaySpecListenerPortMapping" } }, "tls": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTl:getVirtualGatewaySpecListenerTl" } } }, "type": "object", "required": [ "connectionPools", "healthChecks", "portMappings", "tls" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerConnectionPool:getVirtualGatewaySpecListenerConnectionPool": { "properties": { "grpcs": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolGrpc:getVirtualGatewaySpecListenerConnectionPoolGrpc" } }, "http2s": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolHttp2:getVirtualGatewaySpecListenerConnectionPoolHttp2" } }, "https": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolHttp:getVirtualGatewaySpecListenerConnectionPoolHttp" } } }, "type": "object", "required": [ "grpcs", "https", "http2s" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolGrpc:getVirtualGatewaySpecListenerConnectionPoolGrpc": { "properties": { "maxRequests": { "type": "integer" } }, "type": "object", "required": [ "maxRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolHttp2:getVirtualGatewaySpecListenerConnectionPoolHttp2": { "properties": { "maxRequests": { "type": "integer" } }, "type": "object", "required": [ "maxRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerConnectionPoolHttp:getVirtualGatewaySpecListenerConnectionPoolHttp": { "properties": { "maxConnections": { "type": "integer" }, "maxPendingRequests": { "type": "integer" } }, "type": "object", "required": [ "maxConnections", "maxPendingRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerHealthCheck:getVirtualGatewaySpecListenerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer" }, "intervalMillis": { "type": "integer" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" }, "timeoutMillis": { "type": "integer" }, "unhealthyThreshold": { "type": "integer" } }, "type": "object", "required": [ "healthyThreshold", "intervalMillis", "path", "port", "protocol", "timeoutMillis", "unhealthyThreshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerPortMapping:getVirtualGatewaySpecListenerPortMapping": { "properties": { "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object", "required": [ "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTl:getVirtualGatewaySpecListenerTl": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlCertificate:getVirtualGatewaySpecListenerTlCertificate" } }, "mode": { "type": "string" }, "validations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidation:getVirtualGatewaySpecListenerTlValidation" } } }, "type": "object", "required": [ "certificates", "mode", "validations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlCertificate:getVirtualGatewaySpecListenerTlCertificate": { "properties": { "acms": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlCertificateAcm:getVirtualGatewaySpecListenerTlCertificateAcm" } }, "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlCertificateFile:getVirtualGatewaySpecListenerTlCertificateFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlCertificateSd:getVirtualGatewaySpecListenerTlCertificateSd" } } }, "type": "object", "required": [ "acms", "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlCertificateAcm:getVirtualGatewaySpecListenerTlCertificateAcm": { "properties": { "certificateArn": { "type": "string" } }, "type": "object", "required": [ "certificateArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlCertificateFile:getVirtualGatewaySpecListenerTlCertificateFile": { "properties": { "certificateChain": { "type": "string" }, "privateKey": { "type": "string" } }, "type": "object", "required": [ "certificateChain", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlCertificateSd:getVirtualGatewaySpecListenerTlCertificateSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidation:getVirtualGatewaySpecListenerTlValidation": { "properties": { "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidationSubjectAlternativeName:getVirtualGatewaySpecListenerTlValidationSubjectAlternativeName" } }, "trusts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrust:getVirtualGatewaySpecListenerTlValidationTrust" } } }, "type": "object", "required": [ "subjectAlternativeNames", "trusts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidationSubjectAlternativeName:getVirtualGatewaySpecListenerTlValidationSubjectAlternativeName": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidationSubjectAlternativeNameMatch:getVirtualGatewaySpecListenerTlValidationSubjectAlternativeNameMatch" } } }, "type": "object", "required": [ "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidationSubjectAlternativeNameMatch:getVirtualGatewaySpecListenerTlValidationSubjectAlternativeNameMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "exacts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrust:getVirtualGatewaySpecListenerTlValidationTrust": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrustFile:getVirtualGatewaySpecListenerTlValidationTrustFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrustSd:getVirtualGatewaySpecListenerTlValidationTrustSd" } } }, "type": "object", "required": [ "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrustFile:getVirtualGatewaySpecListenerTlValidationTrustFile": { "properties": { "certificateChain": { "type": "string" } }, "type": "object", "required": [ "certificateChain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecListenerTlValidationTrustSd:getVirtualGatewaySpecListenerTlValidationTrustSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecLogging:getVirtualGatewaySpecLogging": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecLoggingAccessLog:getVirtualGatewaySpecLoggingAccessLog" } } }, "type": "object", "required": [ "accessLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecLoggingAccessLog:getVirtualGatewaySpecLoggingAccessLog": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFile:getVirtualGatewaySpecLoggingAccessLogFile" } } }, "type": "object", "required": [ "files" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFile:getVirtualGatewaySpecLoggingAccessLogFile": { "properties": { "formats": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFileFormat:getVirtualGatewaySpecLoggingAccessLogFileFormat" } }, "path": { "type": "string" } }, "type": "object", "required": [ "formats", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFileFormat:getVirtualGatewaySpecLoggingAccessLogFileFormat": { "properties": { "jsons": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFileFormatJson:getVirtualGatewaySpecLoggingAccessLogFileFormatJson" } }, "text": { "type": "string" } }, "type": "object", "required": [ "jsons", "text" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualGatewaySpecLoggingAccessLogFileFormatJson:getVirtualGatewaySpecLoggingAccessLogFileFormatJson": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpec:getVirtualNodeSpec": { "properties": { "backendDefaults": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefault:getVirtualNodeSpecBackendDefault" } }, "backends": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackend:getVirtualNodeSpecBackend" } }, "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListener:getVirtualNodeSpecListener" } }, "loggings": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecLogging:getVirtualNodeSpecLogging" } }, "serviceDiscoveries": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecServiceDiscovery:getVirtualNodeSpecServiceDiscovery" } } }, "type": "object", "required": [ "backends", "backendDefaults", "listeners", "loggings", "serviceDiscoveries" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackend:getVirtualNodeSpecBackend": { "properties": { "virtualServices": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualService:getVirtualNodeSpecBackendVirtualService" } } }, "type": "object", "required": [ "virtualServices" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefault:getVirtualNodeSpecBackendDefault": { "properties": { "clientPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicy:getVirtualNodeSpecBackendDefaultClientPolicy" } } }, "type": "object", "required": [ "clientPolicies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicy:getVirtualNodeSpecBackendDefaultClientPolicy": { "properties": { "tls": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTl:getVirtualNodeSpecBackendDefaultClientPolicyTl" } } }, "type": "object", "required": [ "tls" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTl:getVirtualNodeSpecBackendDefaultClientPolicyTl": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificate:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificate" } }, "enforce": { "type": "boolean" }, "ports": { "type": "array", "items": { "type": "integer" } }, "validations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidation:getVirtualNodeSpecBackendDefaultClientPolicyTlValidation" } } }, "type": "object", "required": [ "certificates", "enforce", "ports", "validations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificate:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificate": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateFile:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateSd:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateSd" } } }, "type": "object", "required": [ "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateFile:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateFile": { "properties": { "certificateChain": { "type": "string" }, "privateKey": { "type": "string" } }, "type": "object", "required": [ "certificateChain", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateSd:getVirtualNodeSpecBackendDefaultClientPolicyTlCertificateSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidation:getVirtualNodeSpecBackendDefaultClientPolicyTlValidation": { "properties": { "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName" } }, "trusts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrust:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrust" } } }, "type": "object", "required": [ "subjectAlternativeNames", "trusts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch" } } }, "type": "object", "required": [ "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "exacts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrust:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrust": { "properties": { "acms": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustAcm:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustAcm" } }, "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustFile:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustSd:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustSd" } } }, "type": "object", "required": [ "acms", "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustAcm:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "certificateAuthorityArns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustFile:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustFile": { "properties": { "certificateChain": { "type": "string" } }, "type": "object", "required": [ "certificateChain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustSd:getVirtualNodeSpecBackendDefaultClientPolicyTlValidationTrustSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualService:getVirtualNodeSpecBackendVirtualService": { "properties": { "clientPolicies": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicy:getVirtualNodeSpecBackendVirtualServiceClientPolicy" } }, "virtualServiceName": { "type": "string" } }, "type": "object", "required": [ "clientPolicies", "virtualServiceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicy:getVirtualNodeSpecBackendVirtualServiceClientPolicy": { "properties": { "tls": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTl:getVirtualNodeSpecBackendVirtualServiceClientPolicyTl" } } }, "type": "object", "required": [ "tls" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTl:getVirtualNodeSpecBackendVirtualServiceClientPolicyTl": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificate:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificate" } }, "enforce": { "type": "boolean" }, "ports": { "type": "array", "items": { "type": "integer" } }, "validations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidation:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidation" } } }, "type": "object", "required": [ "certificates", "enforce", "ports", "validations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificate:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificate": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateFile:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateSd:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateSd" } } }, "type": "object", "required": [ "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateFile:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateFile": { "properties": { "certificateChain": { "type": "string" }, "privateKey": { "type": "string" } }, "type": "object", "required": [ "certificateChain", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateSd:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlCertificateSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidation:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidation": { "properties": { "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeName:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeName" } }, "trusts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrust:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrust" } } }, "type": "object", "required": [ "subjectAlternativeNames", "trusts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeName:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeName": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeNameMatch" } } }, "type": "object", "required": [ "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationSubjectAlternativeNameMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "exacts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrust:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrust": { "properties": { "acms": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustAcm:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustAcm" } }, "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustFile:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustSd:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustSd" } } }, "type": "object", "required": [ "acms", "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustAcm:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustAcm": { "properties": { "certificateAuthorityArns": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "certificateAuthorityArns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustFile:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustFile": { "properties": { "certificateChain": { "type": "string" } }, "type": "object", "required": [ "certificateChain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustSd:getVirtualNodeSpecBackendVirtualServiceClientPolicyTlValidationTrustSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListener:getVirtualNodeSpecListener": { "properties": { "connectionPools": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerConnectionPool:getVirtualNodeSpecListenerConnectionPool" } }, "healthChecks": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerHealthCheck:getVirtualNodeSpecListenerHealthCheck" } }, "outlierDetections": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerOutlierDetection:getVirtualNodeSpecListenerOutlierDetection" } }, "portMappings": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerPortMapping:getVirtualNodeSpecListenerPortMapping" } }, "timeouts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeout:getVirtualNodeSpecListenerTimeout" } }, "tls": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTl:getVirtualNodeSpecListenerTl" } } }, "type": "object", "required": [ "connectionPools", "healthChecks", "outlierDetections", "portMappings", "timeouts", "tls" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerConnectionPool:getVirtualNodeSpecListenerConnectionPool": { "properties": { "grpcs": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerConnectionPoolGrpc:getVirtualNodeSpecListenerConnectionPoolGrpc" } }, "http2s": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerConnectionPoolHttp2:getVirtualNodeSpecListenerConnectionPoolHttp2" } }, "https": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerConnectionPoolHttp:getVirtualNodeSpecListenerConnectionPoolHttp" } }, "tcps": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerConnectionPoolTcp:getVirtualNodeSpecListenerConnectionPoolTcp" } } }, "type": "object", "required": [ "grpcs", "https", "http2s", "tcps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerConnectionPoolGrpc:getVirtualNodeSpecListenerConnectionPoolGrpc": { "properties": { "maxRequests": { "type": "integer" } }, "type": "object", "required": [ "maxRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerConnectionPoolHttp2:getVirtualNodeSpecListenerConnectionPoolHttp2": { "properties": { "maxRequests": { "type": "integer" } }, "type": "object", "required": [ "maxRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerConnectionPoolHttp:getVirtualNodeSpecListenerConnectionPoolHttp": { "properties": { "maxConnections": { "type": "integer" }, "maxPendingRequests": { "type": "integer" } }, "type": "object", "required": [ "maxConnections", "maxPendingRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerConnectionPoolTcp:getVirtualNodeSpecListenerConnectionPoolTcp": { "properties": { "maxConnections": { "type": "integer" } }, "type": "object", "required": [ "maxConnections" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerHealthCheck:getVirtualNodeSpecListenerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer" }, "intervalMillis": { "type": "integer" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" }, "timeoutMillis": { "type": "integer" }, "unhealthyThreshold": { "type": "integer" } }, "type": "object", "required": [ "healthyThreshold", "intervalMillis", "path", "port", "protocol", "timeoutMillis", "unhealthyThreshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerOutlierDetection:getVirtualNodeSpecListenerOutlierDetection": { "properties": { "baseEjectionDurations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration:getVirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration" } }, "intervals": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerOutlierDetectionInterval:getVirtualNodeSpecListenerOutlierDetectionInterval" } }, "maxEjectionPercent": { "type": "integer" }, "maxServerErrors": { "type": "integer" } }, "type": "object", "required": [ "baseEjectionDurations", "intervals", "maxEjectionPercent", "maxServerErrors" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration:getVirtualNodeSpecListenerOutlierDetectionBaseEjectionDuration": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerOutlierDetectionInterval:getVirtualNodeSpecListenerOutlierDetectionInterval": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerPortMapping:getVirtualNodeSpecListenerPortMapping": { "properties": { "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object", "required": [ "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeout:getVirtualNodeSpecListenerTimeout": { "properties": { "grpcs": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpc:getVirtualNodeSpecListenerTimeoutGrpc" } }, "http2s": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2:getVirtualNodeSpecListenerTimeoutHttp2" } }, "https": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp:getVirtualNodeSpecListenerTimeoutHttp" } }, "tcps": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutTcp:getVirtualNodeSpecListenerTimeoutTcp" } } }, "type": "object", "required": [ "grpcs", "https", "http2s", "tcps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpc:getVirtualNodeSpecListenerTimeoutGrpc": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpcIdle:getVirtualNodeSpecListenerTimeoutGrpcIdle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpcPerRequest:getVirtualNodeSpecListenerTimeoutGrpcPerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpcIdle:getVirtualNodeSpecListenerTimeoutGrpcIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutGrpcPerRequest:getVirtualNodeSpecListenerTimeoutGrpcPerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2:getVirtualNodeSpecListenerTimeoutHttp2": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2Idle:getVirtualNodeSpecListenerTimeoutHttp2Idle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2PerRequest:getVirtualNodeSpecListenerTimeoutHttp2PerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2Idle:getVirtualNodeSpecListenerTimeoutHttp2Idle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp2PerRequest:getVirtualNodeSpecListenerTimeoutHttp2PerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttp:getVirtualNodeSpecListenerTimeoutHttp": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttpIdle:getVirtualNodeSpecListenerTimeoutHttpIdle" } }, "perRequests": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutHttpPerRequest:getVirtualNodeSpecListenerTimeoutHttpPerRequest" } } }, "type": "object", "required": [ "idles", "perRequests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttpIdle:getVirtualNodeSpecListenerTimeoutHttpIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutHttpPerRequest:getVirtualNodeSpecListenerTimeoutHttpPerRequest": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutTcp:getVirtualNodeSpecListenerTimeoutTcp": { "properties": { "idles": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTimeoutTcpIdle:getVirtualNodeSpecListenerTimeoutTcpIdle" } } }, "type": "object", "required": [ "idles" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTimeoutTcpIdle:getVirtualNodeSpecListenerTimeoutTcpIdle": { "properties": { "unit": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTl:getVirtualNodeSpecListenerTl": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlCertificate:getVirtualNodeSpecListenerTlCertificate" } }, "mode": { "type": "string" }, "validations": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidation:getVirtualNodeSpecListenerTlValidation" } } }, "type": "object", "required": [ "certificates", "mode", "validations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlCertificate:getVirtualNodeSpecListenerTlCertificate": { "properties": { "acms": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlCertificateAcm:getVirtualNodeSpecListenerTlCertificateAcm" } }, "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlCertificateFile:getVirtualNodeSpecListenerTlCertificateFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlCertificateSd:getVirtualNodeSpecListenerTlCertificateSd" } } }, "type": "object", "required": [ "acms", "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlCertificateAcm:getVirtualNodeSpecListenerTlCertificateAcm": { "properties": { "certificateArn": { "type": "string" } }, "type": "object", "required": [ "certificateArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlCertificateFile:getVirtualNodeSpecListenerTlCertificateFile": { "properties": { "certificateChain": { "type": "string" }, "privateKey": { "type": "string" } }, "type": "object", "required": [ "certificateChain", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlCertificateSd:getVirtualNodeSpecListenerTlCertificateSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidation:getVirtualNodeSpecListenerTlValidation": { "properties": { "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidationSubjectAlternativeName:getVirtualNodeSpecListenerTlValidationSubjectAlternativeName" } }, "trusts": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidationTrust:getVirtualNodeSpecListenerTlValidationTrust" } } }, "type": "object", "required": [ "subjectAlternativeNames", "trusts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidationSubjectAlternativeName:getVirtualNodeSpecListenerTlValidationSubjectAlternativeName": { "properties": { "matches": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecListenerTlValidationSubjectAlternativeNameMatch" } } }, "type": "object", "required": [ "matches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidationSubjectAlternativeNameMatch:getVirtualNodeSpecListenerTlValidationSubjectAlternativeNameMatch": { "properties": { "exacts": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "exacts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidationTrust:getVirtualNodeSpecListenerTlValidationTrust": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidationTrustFile:getVirtualNodeSpecListenerTlValidationTrustFile" } }, "sds": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecListenerTlValidationTrustSd:getVirtualNodeSpecListenerTlValidationTrustSd" } } }, "type": "object", "required": [ "files", "sds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidationTrustFile:getVirtualNodeSpecListenerTlValidationTrustFile": { "properties": { "certificateChain": { "type": "string" } }, "type": "object", "required": [ "certificateChain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecListenerTlValidationTrustSd:getVirtualNodeSpecListenerTlValidationTrustSd": { "properties": { "secretName": { "type": "string" } }, "type": "object", "required": [ "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecLogging:getVirtualNodeSpecLogging": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecLoggingAccessLog:getVirtualNodeSpecLoggingAccessLog" } } }, "type": "object", "required": [ "accessLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecLoggingAccessLog:getVirtualNodeSpecLoggingAccessLog": { "properties": { "files": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecLoggingAccessLogFile:getVirtualNodeSpecLoggingAccessLogFile" } } }, "type": "object", "required": [ "files" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecLoggingAccessLogFile:getVirtualNodeSpecLoggingAccessLogFile": { "properties": { "formats": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecLoggingAccessLogFileFormat:getVirtualNodeSpecLoggingAccessLogFileFormat" } }, "path": { "type": "string" } }, "type": "object", "required": [ "formats", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecLoggingAccessLogFileFormat:getVirtualNodeSpecLoggingAccessLogFileFormat": { "properties": { "jsons": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecLoggingAccessLogFileFormatJson:getVirtualNodeSpecLoggingAccessLogFileFormatJson" } }, "text": { "type": "string" } }, "type": "object", "required": [ "jsons", "text" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecLoggingAccessLogFileFormatJson:getVirtualNodeSpecLoggingAccessLogFileFormatJson": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecServiceDiscovery:getVirtualNodeSpecServiceDiscovery": { "properties": { "awsCloudMaps": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecServiceDiscoveryAwsCloudMap:getVirtualNodeSpecServiceDiscoveryAwsCloudMap" } }, "dns": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualNodeSpecServiceDiscoveryDn:getVirtualNodeSpecServiceDiscoveryDn" } } }, "type": "object", "required": [ "awsCloudMaps", "dns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecServiceDiscoveryAwsCloudMap:getVirtualNodeSpecServiceDiscoveryAwsCloudMap": { "properties": { "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "namespaceName": { "type": "string" }, "serviceName": { "type": "string" } }, "type": "object", "required": [ "attributes", "namespaceName", "serviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualNodeSpecServiceDiscoveryDn:getVirtualNodeSpecServiceDiscoveryDn": { "properties": { "hostname": { "type": "string" }, "ipPreference": { "type": "string" }, "responseType": { "type": "string" } }, "type": "object", "required": [ "hostname", "ipPreference", "responseType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualRouterSpec:getVirtualRouterSpec": { "properties": { "listeners": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualRouterSpecListener:getVirtualRouterSpecListener" } } }, "type": "object", "required": [ "listeners" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualRouterSpecListener:getVirtualRouterSpecListener": { "properties": { "portMappings": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualRouterSpecListenerPortMapping:getVirtualRouterSpecListenerPortMapping" } } }, "type": "object", "required": [ "portMappings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualRouterSpecListenerPortMapping:getVirtualRouterSpecListenerPortMapping": { "properties": { "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object", "required": [ "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualServiceSpec:getVirtualServiceSpec": { "properties": { "providers": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualServiceSpecProvider:getVirtualServiceSpecProvider" } } }, "type": "object", "required": [ "providers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualServiceSpecProvider:getVirtualServiceSpecProvider": { "properties": { "virtualNodes": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualServiceSpecProviderVirtualNode:getVirtualServiceSpecProviderVirtualNode" } }, "virtualRouters": { "type": "array", "items": { "$ref": "#/types/aws:appmesh/getVirtualServiceSpecProviderVirtualRouter:getVirtualServiceSpecProviderVirtualRouter" } } }, "type": "object", "required": [ "virtualNodes", "virtualRouters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualServiceSpecProviderVirtualNode:getVirtualServiceSpecProviderVirtualNode": { "properties": { "virtualNodeName": { "type": "string" } }, "type": "object", "required": [ "virtualNodeName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appmesh/getVirtualServiceSpecProviderVirtualRouter:getVirtualServiceSpecProviderVirtualRouter": { "properties": { "virtualRouterName": { "type": "string" } }, "type": "object", "required": [ "virtualRouterName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:apprunner/CustomDomainAssociationCertificateValidationRecord:CustomDomainAssociationCertificateValidationRecord": { "properties": { "name": { "type": "string", "description": "Certificate CNAME record name.\n" }, "status": { "type": "string", "description": "Current state of the certificate CNAME record validation. It should change to `SUCCESS` after App Runner completes validation with your DNS.\n" }, "type": { "type": "string", "description": "Record type, always `CNAME`.\n" }, "value": { "type": "string", "description": "Certificate CNAME record value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "status", "type", "value" ] } } }, "aws:apprunner/DeploymentTimeouts:DeploymentTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:apprunner/ObservabilityConfigurationTraceConfiguration:ObservabilityConfigurationTraceConfiguration": { "properties": { "vendor": { "type": "string", "description": "Implementation provider chosen for tracing App Runner services. Valid values: `AWSXRAY`.\n" } }, "type": "object" }, "aws:apprunner/ServiceEncryptionConfiguration:ServiceEncryptionConfiguration": { "properties": { "kmsKey": { "type": "string", "description": "ARN of the KMS key used for encryption.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "kmsKey" ] }, "aws:apprunner/ServiceHealthCheckConfiguration:ServiceHealthCheckConfiguration": { "properties": { "healthyThreshold": { "type": "integer", "description": "Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.\n" }, "interval": { "type": "integer", "description": "Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.\n" }, "path": { "type": "string", "description": "URL to send requests to for health checks. Defaults to `/`. Minimum length of 0. Maximum length of 51200.\n" }, "protocol": { "type": "string", "description": "IP protocol that App Runner uses to perform health checks for your service. Valid values: `TCP`, `HTTP`. Defaults to `TCP`. If you set protocol to `HTTP`, App Runner sends health check requests to the HTTP path specified by `path`.\n" }, "timeout": { "type": "integer", "description": "Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.\n" } }, "type": "object" }, "aws:apprunner/ServiceInstanceConfiguration:ServiceInstanceConfiguration": { "properties": { "cpu": { "type": "string", "description": "Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to `1024`. Valid values: `256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU`.\n" }, "instanceRoleArn": { "type": "string", "description": "ARN of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.\n" }, "memory": { "type": "string", "description": "Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to `2048`. Valid values: `512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB`.\n" } }, "type": "object" }, "aws:apprunner/ServiceNetworkConfiguration:ServiceNetworkConfiguration": { "properties": { "egressConfiguration": { "$ref": "#/types/aws:apprunner/ServiceNetworkConfigurationEgressConfiguration:ServiceNetworkConfigurationEgressConfiguration", "description": "Network configuration settings for outbound message traffic. See Egress Configuration below for more details.\n" }, "ingressConfiguration": { "$ref": "#/types/aws:apprunner/ServiceNetworkConfigurationIngressConfiguration:ServiceNetworkConfigurationIngressConfiguration", "description": "Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.\n" }, "ipAddressType": { "type": "string", "description": "App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. Valid values: `IPV4`, `DUAL_STACK`. Default: `IPV4`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "egressConfiguration", "ingressConfiguration" ] } } }, "aws:apprunner/ServiceNetworkConfigurationEgressConfiguration:ServiceNetworkConfigurationEgressConfiguration": { "properties": { "egressType": { "type": "string", "description": "The type of egress configuration. Valid values are: `DEFAULT` and `VPC`.\n" }, "vpcConnectorArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when `EgressType = VPC`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "egressType" ] } } }, "aws:apprunner/ServiceNetworkConfigurationIngressConfiguration:ServiceNetworkConfigurationIngressConfiguration": { "properties": { "isPubliclyAccessible": { "type": "boolean", "description": "Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.\n" } }, "type": "object" }, "aws:apprunner/ServiceObservabilityConfiguration:ServiceObservabilityConfiguration": { "properties": { "observabilityConfigurationArn": { "type": "string", "description": "ARN of the observability configuration that is associated with the service. Specified only when `observability_enabled` is `true`.\n" }, "observabilityEnabled": { "type": "boolean", "description": "When `true`, an observability configuration resource is associated with the service.\n" } }, "type": "object", "required": [ "observabilityEnabled" ] }, "aws:apprunner/ServiceSourceConfiguration:ServiceSourceConfiguration": { "properties": { "authenticationConfiguration": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationAuthenticationConfiguration:ServiceSourceConfigurationAuthenticationConfiguration", "description": "Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.\n" }, "autoDeploymentsEnabled": { "type": "boolean", "description": "Whether continuous integration from the source repository is enabled for the App Runner service. If set to `true`, each repository change (source code commit or new image version) starts a deployment. Defaults to `true`.\n" }, "codeRepository": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationCodeRepository:ServiceSourceConfigurationCodeRepository", "description": "Description of a source code repository. See Code Repository below for more details.\n" }, "imageRepository": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationImageRepository:ServiceSourceConfigurationImageRepository", "description": "Description of a source image repository. See Image Repository below for more details.\n" } }, "type": "object" }, "aws:apprunner/ServiceSourceConfigurationAuthenticationConfiguration:ServiceSourceConfigurationAuthenticationConfiguration": { "properties": { "accessRoleArn": { "type": "string", "description": "ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)\n" }, "connectionArn": { "type": "string", "description": "ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.\n" } }, "type": "object" }, "aws:apprunner/ServiceSourceConfigurationCodeRepository:ServiceSourceConfigurationCodeRepository": { "properties": { "codeConfiguration": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationCodeRepositoryCodeConfiguration:ServiceSourceConfigurationCodeRepositoryCodeConfiguration", "description": "Configuration for building and running the service from a source code repository. See Code Configuration below for more details.\n" }, "repositoryUrl": { "type": "string", "description": "Location of the repository that contains the source code.\n" }, "sourceCodeVersion": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationCodeRepositorySourceCodeVersion:ServiceSourceConfigurationCodeRepositorySourceCodeVersion", "description": "Version that should be used within the source code repository. See Source Code Version below for more details.\n" }, "sourceDirectory": { "type": "string", "description": "The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.\n" } }, "type": "object", "required": [ "repositoryUrl", "sourceCodeVersion" ], "language": { "nodejs": { "requiredOutputs": [ "repositoryUrl", "sourceCodeVersion", "sourceDirectory" ] } } }, "aws:apprunner/ServiceSourceConfigurationCodeRepositoryCodeConfiguration:ServiceSourceConfigurationCodeRepositoryCodeConfiguration": { "properties": { "codeConfigurationValues": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues:ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues", "description": "Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.\n" }, "configurationSource": { "type": "string", "description": "Source of the App Runner configuration. Valid values: `REPOSITORY`, `API`. Values are interpreted as follows:\n* `REPOSITORY` - App Runner reads configuration values from the apprunner.yaml file in the\nsource code repository and ignores the CodeConfigurationValues parameter.\n* `API` - App Runner uses configuration values provided in the CodeConfigurationValues\nparameter and ignores the apprunner.yaml file in the source code repository.\n" } }, "type": "object", "required": [ "configurationSource" ] }, "aws:apprunner/ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues:ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues": { "properties": { "buildCommand": { "type": "string", "description": "Command App Runner runs to build your application.\n" }, "port": { "type": "string", "description": "Port that your application listens to in the container. Defaults to `\"8080\"`.\n" }, "runtime": { "type": "string", "description": "Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: `PYTHON_3`, `NODEJS_12`, `NODEJS_14`, `NODEJS_16`, `CORRETTO_8`, `CORRETTO_11`, `GO_1`, `DOTNET_6`, `PHP_81`, `RUBY_31`.\n" }, "runtimeEnvironmentSecrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.\n" }, "runtimeEnvironmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid.\n" }, "startCommand": { "type": "string", "description": "Command App Runner runs to start your application.\n" } }, "type": "object", "required": [ "runtime" ] }, "aws:apprunner/ServiceSourceConfigurationCodeRepositorySourceCodeVersion:ServiceSourceConfigurationCodeRepositorySourceCodeVersion": { "properties": { "type": { "type": "string", "description": "Type of version identifier. For a git-based repository, branches represent versions. Valid values: `BRANCH`.\n" }, "value": { "type": "string", "description": "Source code version. For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.\n" } }, "type": "object", "required": [ "type", "value" ] }, "aws:apprunner/ServiceSourceConfigurationImageRepository:ServiceSourceConfigurationImageRepository": { "properties": { "imageConfiguration": { "$ref": "#/types/aws:apprunner/ServiceSourceConfigurationImageRepositoryImageConfiguration:ServiceSourceConfigurationImageRepositoryImageConfiguration", "description": "Configuration for running the identified image. See Image Configuration below for more details.\n" }, "imageIdentifier": { "type": "string", "description": "Identifier of an image. For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the\nimage name format, see Pulling an image in the Amazon ECR User Guide.\n" }, "imageRepositoryType": { "type": "string", "description": "Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: `ECR` , `ECR_PUBLIC`.\n" } }, "type": "object", "required": [ "imageIdentifier", "imageRepositoryType" ] }, "aws:apprunner/ServiceSourceConfigurationImageRepositoryImageConfiguration:ServiceSourceConfigurationImageRepositoryImageConfiguration": { "properties": { "port": { "type": "string", "description": "Port that your application listens to in the container. Defaults to `\"8080\"`.\n" }, "runtimeEnvironmentSecrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.\n" }, "runtimeEnvironmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid.\n" }, "startCommand": { "type": "string", "description": "Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.\n" } }, "type": "object" }, "aws:apprunner/VpcIngressConnectionIngressVpcConfiguration:VpcIngressConnectionIngressVpcConfiguration": { "properties": { "vpcEndpointId": { "type": "string", "description": "The ID of the VPC endpoint that your App Runner service connects to.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The ID of the VPC that is used for the VPC endpoint.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:appstream/DirectoryConfigServiceAccountCredentials:DirectoryConfigServiceAccountCredentials": { "properties": { "accountName": { "type": "string", "description": "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.\n" }, "accountPassword": { "type": "string", "description": "Password for the account.\n", "secret": true } }, "type": "object", "required": [ "accountName", "accountPassword" ] }, "aws:appstream/FleetComputeCapacity:FleetComputeCapacity": { "properties": { "available": { "type": "integer", "description": "Number of currently available instances that can be used to stream sessions.\n" }, "desiredInstances": { "type": "integer", "description": "Desired number of streaming instances.\n" }, "desiredSessions": { "type": "integer", "description": "Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.\n" }, "inUse": { "type": "integer", "description": "Number of instances in use for streaming.\n" }, "running": { "type": "integer", "description": "Total number of simultaneous streaming instances that are running.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "available", "inUse", "running" ] } } }, "aws:appstream/FleetDomainJoinInfo:FleetDomainJoinInfo": { "properties": { "directoryName": { "type": "string", "description": "Fully qualified name of the directory (for example, corp.example.com).\n" }, "organizationalUnitDistinguishedName": { "type": "string", "description": "Distinguished name of the organizational unit for computer accounts.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "directoryName", "organizationalUnitDistinguishedName" ] } } }, "aws:appstream/FleetVpcConfig:FleetVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the security groups for the fleet or image builder.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetIds" ] } } }, "aws:appstream/ImageBuilderAccessEndpoint:ImageBuilderAccessEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Type of interface endpoint. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/appstream2/latest/APIReference/API_AccessEndpoint.html).\n" }, "vpceId": { "type": "string", "description": "Identifier (ID) of the interface VPC endpoint.\n" } }, "type": "object", "required": [ "endpointType" ], "language": { "nodejs": { "requiredOutputs": [ "endpointType", "vpceId" ] } } }, "aws:appstream/ImageBuilderDomainJoinInfo:ImageBuilderDomainJoinInfo": { "properties": { "directoryName": { "type": "string", "description": "Fully qualified name of the directory (for example, corp.example.com).\n" }, "organizationalUnitDistinguishedName": { "type": "string", "description": "Distinguished name of the organizational unit for computer accounts.\n" } }, "type": "object" }, "aws:appstream/ImageBuilderVpcConfig:ImageBuilderVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the security groups for the image builder or image builder.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of the subnet to which a network interface is attached from the image builder instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetIds" ] } } }, "aws:appstream/StackAccessEndpoint:StackAccessEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Type of the interface endpoint.\nSee the [`AccessEndpoint` AWS API documentation](https://docs.aws.amazon.com/appstream2/latest/APIReference/API_AccessEndpoint.html) for valid values.\n" }, "vpceId": { "type": "string", "description": "ID of the VPC in which the interface endpoint is used.\n" } }, "type": "object", "required": [ "endpointType" ], "language": { "nodejs": { "requiredOutputs": [ "endpointType", "vpceId" ] } } }, "aws:appstream/StackApplicationSettings:StackApplicationSettings": { "properties": { "enabled": { "type": "boolean", "description": "Whether application settings should be persisted.\n" }, "settingsGroup": { "type": "string", "description": "Name of the settings group.\nRequired when `enabled` is `true`.\nCan be up to 100 characters.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:appstream/StackStorageConnector:StackStorageConnector": { "properties": { "connectorType": { "type": "string", "description": "Type of storage connector.\nValid values are `HOMEFOLDERS`, `GOOGLE_DRIVE`, or `ONE_DRIVE`.\n" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Names of the domains for the account.\n" }, "resourceIdentifier": { "type": "string", "description": "ARN of the storage connector.\n" } }, "type": "object", "required": [ "connectorType" ], "language": { "nodejs": { "requiredOutputs": [ "connectorType", "domains", "resourceIdentifier" ] } } }, "aws:appstream/StackStreamingExperienceSettings:StackStreamingExperienceSettings": { "properties": { "preferredProtocol": { "type": "string", "description": "The preferred protocol that you want to use while streaming your application.\nValid values are `TCP` and `UDP`.\n" } }, "type": "object" }, "aws:appstream/StackUserSetting:StackUserSetting": { "properties": { "action": { "type": "string", "description": "Action that is enabled or disabled.\nValid values are `AUTO_TIME_ZONE_REDIRECTION`, `CLIPBOARD_COPY_FROM_LOCAL_DEVICE`, `CLIPBOARD_COPY_TO_LOCAL_DEVICE`, `DOMAIN_PASSWORD_SIGNIN`, `DOMAIN_SMART_CARD_SIGNIN`, `FILE_UPLOAD`, `FILE_DOWNLOAD`, or `PRINTING_TO_LOCAL_DEVICE`.\n" }, "permission": { "type": "string", "description": "Whether the action is enabled or disabled.\nValid values are `ENABLED` or `DISABLED`.\n" } }, "type": "object", "required": [ "action", "permission" ] }, "aws:appstream/getImageApplication:getImageApplication": { "properties": { "appBlockArn": { "type": "string", "description": "The app block ARN of the application.\n" }, "arn": { "type": "string", "description": "Arn of the image being searched for. Cannot be used with name_regex or name.\n" }, "createdTime": { "type": "string", "description": "Time at which this image was created.\n" }, "description": { "type": "string", "description": "Description of image.\n" }, "displayName": { "type": "string", "description": "Image name to display.\n" }, "enabled": { "type": "boolean", "description": "Bool based on if the application is enabled.\n" }, "iconS3Locations": { "type": "array", "items": { "$ref": "#/types/aws:appstream/getImageApplicationIconS3Location:getImageApplicationIconS3Location" }, "description": "A list named icon_s3_location that contains the following:\n" }, "iconUrl": { "type": "string", "description": "URL of the application icon. This URL may be time-limited.\n" }, "instanceFamilies": { "type": "array", "items": { "type": "string" }, "description": "List of the instance families of the application.\n" }, "launchParameters": { "type": "string", "description": "Arguments that are passed to the application at it's launch.\n" }, "launchPath": { "type": "string", "description": "Path to the application's excecutable in the instance.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "String to string map that contains additional attributes used to describe the application.\n* `Name` - Name of the application.\n" }, "name": { "type": "string", "description": "Name of the image being searched for. Cannot be used with name_regex or arn.\n" }, "platforms": { "type": "array", "items": { "type": "string" }, "description": "Array of strings describing the platforms on which the application can run.\nValues will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2\n" }, "workingDirectory": { "type": "string", "description": "Working directory for the application.\n" } }, "type": "object", "required": [ "appBlockArn", "arn", "createdTime", "description", "displayName", "enabled", "iconS3Locations", "iconUrl", "instanceFamilies", "launchParameters", "launchPath", "metadata", "name", "platforms", "workingDirectory" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appstream/getImageApplicationIconS3Location:getImageApplicationIconS3Location": { "properties": { "s3Bucket": { "type": "string", "description": "S3 bucket of the S3 object.\n" }, "s3Key": { "type": "string", "description": "S3 key of the S3 object.\n" } }, "type": "object", "required": [ "s3Bucket", "s3Key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appstream/getImageImagePermission:getImageImagePermission": { "properties": { "allowFleet": { "type": "boolean", "description": "Boolean indicating if the image can be used for a fleet.\n" }, "allowImageBuilder": { "type": "boolean", "description": "indicated whether the image can be used for an image builder.\n" } }, "type": "object", "required": [ "allowFleet", "allowImageBuilder" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appstream/getImageStateChangeReason:getImageStateChangeReason": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:appsync/DataSourceDynamodbConfig:DataSourceDynamodbConfig": { "properties": { "deltaSyncConfig": { "$ref": "#/types/aws:appsync/DataSourceDynamodbConfigDeltaSyncConfig:DataSourceDynamodbConfigDeltaSyncConfig", "description": "The DeltaSyncConfig for a versioned data source. See `delta_sync_config` Block for details.\n" }, "region": { "type": "string", "description": "AWS region of the DynamoDB table. Defaults to current region.\n" }, "tableName": { "type": "string", "description": "Name of the DynamoDB table.\n" }, "useCallerCredentials": { "type": "boolean", "description": "Set to `true` to use Amazon Cognito credentials with this data source.\n" }, "versioned": { "type": "boolean", "description": "Detects Conflict Detection and Resolution with this data source.\n" } }, "type": "object", "required": [ "tableName" ], "language": { "nodejs": { "requiredOutputs": [ "region", "tableName" ] } } }, "aws:appsync/DataSourceDynamodbConfigDeltaSyncConfig:DataSourceDynamodbConfigDeltaSyncConfig": { "properties": { "baseTableTtl": { "type": "integer", "description": "The number of minutes that an Item is stored in the data source.\n" }, "deltaSyncTableName": { "type": "string", "description": "The table name.\n" }, "deltaSyncTableTtl": { "type": "integer", "description": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.\n" } }, "type": "object", "required": [ "deltaSyncTableName" ] }, "aws:appsync/DataSourceElasticsearchConfig:DataSourceElasticsearchConfig": { "properties": { "endpoint": { "type": "string", "description": "HTTP endpoint of the Elasticsearch domain.\n" }, "region": { "type": "string", "description": "AWS region of Elasticsearch domain. Defaults to current region.\n" } }, "type": "object", "required": [ "endpoint" ], "language": { "nodejs": { "requiredOutputs": [ "endpoint", "region" ] } } }, "aws:appsync/DataSourceEventBridgeConfig:DataSourceEventBridgeConfig": { "properties": { "eventBusArn": { "type": "string", "description": "ARN for the EventBridge bus.\n" } }, "type": "object", "required": [ "eventBusArn" ] }, "aws:appsync/DataSourceHttpConfig:DataSourceHttpConfig": { "properties": { "authorizationConfig": { "$ref": "#/types/aws:appsync/DataSourceHttpConfigAuthorizationConfig:DataSourceHttpConfigAuthorizationConfig", "description": "Authorization configuration in case the HTTP endpoint requires authorization. See `authorization_config` Block for details.\n" }, "endpoint": { "type": "string", "description": "HTTP URL.\n" } }, "type": "object", "required": [ "endpoint" ] }, "aws:appsync/DataSourceHttpConfigAuthorizationConfig:DataSourceHttpConfigAuthorizationConfig": { "properties": { "authorizationType": { "type": "string", "description": "Authorization type that the HTTP endpoint requires. Default values is `AWS_IAM`.\n" }, "awsIamConfig": { "$ref": "#/types/aws:appsync/DataSourceHttpConfigAuthorizationConfigAwsIamConfig:DataSourceHttpConfigAuthorizationConfigAwsIamConfig", "description": "Identity and Access Management (IAM) settings. See `aws_iam_config` Block for details.\n" } }, "type": "object" }, "aws:appsync/DataSourceHttpConfigAuthorizationConfigAwsIamConfig:DataSourceHttpConfigAuthorizationConfigAwsIamConfig": { "properties": { "signingRegion": { "type": "string", "description": "Signing Amazon Web Services Region for IAM authorization.\n" }, "signingServiceName": { "type": "string", "description": "Signing service name for IAM authorization.\n" } }, "type": "object" }, "aws:appsync/DataSourceLambdaConfig:DataSourceLambdaConfig": { "properties": { "functionArn": { "type": "string", "description": "ARN for the Lambda function.\n" } }, "type": "object", "required": [ "functionArn" ] }, "aws:appsync/DataSourceOpensearchserviceConfig:DataSourceOpensearchserviceConfig": { "properties": { "endpoint": { "type": "string", "description": "HTTP endpoint of the OpenSearch domain.\n" }, "region": { "type": "string", "description": "AWS region of the OpenSearch domain. Defaults to current region.\n" } }, "type": "object", "required": [ "endpoint" ], "language": { "nodejs": { "requiredOutputs": [ "endpoint", "region" ] } } }, "aws:appsync/DataSourceRelationalDatabaseConfig:DataSourceRelationalDatabaseConfig": { "properties": { "httpEndpointConfig": { "$ref": "#/types/aws:appsync/DataSourceRelationalDatabaseConfigHttpEndpointConfig:DataSourceRelationalDatabaseConfigHttpEndpointConfig", "description": "Amazon RDS HTTP endpoint configuration. See `http_endpoint_config` Block for details.\n" }, "sourceType": { "type": "string", "description": "Source type for the relational database. Valid values: `RDS_HTTP_ENDPOINT`.\n" } }, "type": "object" }, "aws:appsync/DataSourceRelationalDatabaseConfigHttpEndpointConfig:DataSourceRelationalDatabaseConfigHttpEndpointConfig": { "properties": { "awsSecretStoreArn": { "type": "string", "description": "AWS secret store ARN for database credentials.\n" }, "databaseName": { "type": "string", "description": "Logical database name.\n" }, "dbClusterIdentifier": { "type": "string", "description": "Amazon RDS cluster identifier.\n" }, "region": { "type": "string", "description": "AWS Region for RDS HTTP endpoint. Defaults to current region.\n" }, "schema": { "type": "string", "description": "Logical schema name.\n" } }, "type": "object", "required": [ "awsSecretStoreArn", "dbClusterIdentifier" ], "language": { "nodejs": { "requiredOutputs": [ "awsSecretStoreArn", "dbClusterIdentifier", "region" ] } } }, "aws:appsync/FunctionRuntime:FunctionRuntime": { "properties": { "name": { "type": "string", "description": "The name of the runtime to use. Currently, the only allowed value is `APPSYNC_JS`.\n" }, "runtimeVersion": { "type": "string", "description": "The version of the runtime to use. Currently, the only allowed version is `1.0.0`.\n" } }, "type": "object", "required": [ "name", "runtimeVersion" ] }, "aws:appsync/FunctionSyncConfig:FunctionSyncConfig": { "properties": { "conflictDetection": { "type": "string", "description": "Conflict Detection strategy to use. Valid values are `NONE` and `VERSION`.\n" }, "conflictHandler": { "type": "string", "description": "Conflict Resolution strategy to perform in the event of a conflict. Valid values are `NONE`, `OPTIMISTIC_CONCURRENCY`, `AUTOMERGE`, and `LAMBDA`.\n" }, "lambdaConflictHandlerConfig": { "$ref": "#/types/aws:appsync/FunctionSyncConfigLambdaConflictHandlerConfig:FunctionSyncConfigLambdaConflictHandlerConfig", "description": "Lambda Conflict Handler Config when configuring `LAMBDA` as the Conflict Handler. See `lambda_conflict_handler_config` Block for details.\n" } }, "type": "object" }, "aws:appsync/FunctionSyncConfigLambdaConflictHandlerConfig:FunctionSyncConfigLambdaConflictHandlerConfig": { "properties": { "lambdaConflictHandlerArn": { "type": "string", "description": "ARN for the Lambda function to use as the Conflict Handler.\n" } }, "type": "object" }, "aws:appsync/GraphQLApiAdditionalAuthenticationProvider:GraphQLApiAdditionalAuthenticationProvider": { "properties": { "authenticationType": { "type": "string", "description": "Authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`\n" }, "lambdaAuthorizerConfig": { "$ref": "#/types/aws:appsync/GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig:GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig", "description": "Nested argument containing Lambda authorizer configuration. See `lambda_authorizer_config` Block for details.\n" }, "openidConnectConfig": { "$ref": "#/types/aws:appsync/GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig:GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig", "description": "Nested argument containing OpenID Connect configuration. See `openid_connect_config` Block for details.\n" }, "userPoolConfig": { "$ref": "#/types/aws:appsync/GraphQLApiAdditionalAuthenticationProviderUserPoolConfig:GraphQLApiAdditionalAuthenticationProviderUserPoolConfig", "description": "Amazon Cognito User Pool configuration. See `user_pool_config` Block for details.\n" } }, "type": "object", "required": [ "authenticationType" ] }, "aws:appsync/GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig:GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig": { "properties": { "authorizerResultTtlInSeconds": { "type": "integer", "description": "Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a `ttlOverride` key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.\n" }, "authorizerUri": { "type": "string", "description": "ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow `lambda:InvokeFunction` from service principal `appsync.amazonaws.com`.\n" }, "identityValidationExpression": { "type": "string", "description": "Regular expression for validation of tokens before the Lambda function is called.\n" } }, "type": "object", "required": [ "authorizerUri" ] }, "aws:appsync/GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig:GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig": { "properties": { "authTtl": { "type": "integer", "description": "Number of milliseconds a token is valid after being authenticated.\n" }, "clientId": { "type": "string", "description": "Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.\n" }, "iatTtl": { "type": "integer", "description": "Number of milliseconds a token is valid after being issued to a user.\n" }, "issuer": { "type": "string", "description": "Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.\n" } }, "type": "object", "required": [ "issuer" ] }, "aws:appsync/GraphQLApiAdditionalAuthenticationProviderUserPoolConfig:GraphQLApiAdditionalAuthenticationProviderUserPoolConfig": { "properties": { "appIdClientRegex": { "type": "string", "description": "Regular expression for validating the incoming Amazon Cognito User Pool app client ID.\n" }, "awsRegion": { "type": "string", "description": "AWS region in which the user pool was created.\n" }, "userPoolId": { "type": "string", "description": "User pool ID.\n" } }, "type": "object", "required": [ "userPoolId" ], "language": { "nodejs": { "requiredOutputs": [ "awsRegion", "userPoolId" ] } } }, "aws:appsync/GraphQLApiEnhancedMetricsConfig:GraphQLApiEnhancedMetricsConfig": { "properties": { "dataSourceLevelMetricsBehavior": { "type": "string", "description": "How data source metrics will be emitted to CloudWatch. Valid values: `FULL_REQUEST_DATA_SOURCE_METRICS`, `PER_DATA_SOURCE_METRICS`\n" }, "operationLevelMetricsConfig": { "type": "string", "description": "How operation metrics will be emitted to CloudWatch. Valid values: `ENABLED`, `DISABLED`\n" }, "resolverLevelMetricsBehavior": { "type": "string", "description": "How resolver metrics will be emitted to CloudWatch. Valid values: `FULL_REQUEST_RESOLVER_METRICS`, `PER_RESOLVER_METRICS`\n" } }, "type": "object", "required": [ "dataSourceLevelMetricsBehavior", "operationLevelMetricsConfig", "resolverLevelMetricsBehavior" ] }, "aws:appsync/GraphQLApiLambdaAuthorizerConfig:GraphQLApiLambdaAuthorizerConfig": { "properties": { "authorizerResultTtlInSeconds": { "type": "integer", "description": "Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a `ttlOverride` key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.\n" }, "authorizerUri": { "type": "string", "description": "ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow `lambda:InvokeFunction` from service principal `appsync.amazonaws.com`.\n" }, "identityValidationExpression": { "type": "string", "description": "Regular expression for validation of tokens before the Lambda function is called.\n" } }, "type": "object", "required": [ "authorizerUri" ] }, "aws:appsync/GraphQLApiLogConfig:GraphQLApiLogConfig": { "properties": { "cloudwatchLogsRoleArn": { "type": "string", "description": "Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.\n" }, "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. Valid values: `true`, `false`. Default value: `false`\n" }, "fieldLogLevel": { "type": "string", "description": "Field logging level. Valid values: `ALL`, `ERROR`, `NONE`.\n" } }, "type": "object", "required": [ "cloudwatchLogsRoleArn", "fieldLogLevel" ] }, "aws:appsync/GraphQLApiOpenidConnectConfig:GraphQLApiOpenidConnectConfig": { "properties": { "authTtl": { "type": "integer", "description": "Number of milliseconds a token is valid after being authenticated.\n" }, "clientId": { "type": "string", "description": "Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.\n" }, "iatTtl": { "type": "integer", "description": "Number of milliseconds a token is valid after being issued to a user.\n" }, "issuer": { "type": "string", "description": "Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.\n" } }, "type": "object", "required": [ "issuer" ] }, "aws:appsync/GraphQLApiUserPoolConfig:GraphQLApiUserPoolConfig": { "properties": { "appIdClientRegex": { "type": "string", "description": "Regular expression for validating the incoming Amazon Cognito User Pool app client ID.\n" }, "awsRegion": { "type": "string", "description": "AWS region in which the user pool was created.\n" }, "defaultAction": { "type": "string", "description": "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. Valid: `ALLOW` and `DENY`\n" }, "userPoolId": { "type": "string", "description": "User pool ID.\n" } }, "type": "object", "required": [ "defaultAction", "userPoolId" ], "language": { "nodejs": { "requiredOutputs": [ "awsRegion", "defaultAction", "userPoolId" ] } } }, "aws:appsync/ResolverCachingConfig:ResolverCachingConfig": { "properties": { "cachingKeys": { "type": "array", "items": { "type": "string" }, "description": "The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.\n" }, "ttl": { "type": "integer", "description": "The TTL in seconds for a resolver that has caching activated. Valid values are between `1` and `3600` seconds.\n" } }, "type": "object" }, "aws:appsync/ResolverPipelineConfig:ResolverPipelineConfig": { "properties": { "functions": { "type": "array", "items": { "type": "string" }, "description": "A list of Function objects.\n" } }, "type": "object" }, "aws:appsync/ResolverRuntime:ResolverRuntime": { "properties": { "name": { "type": "string", "description": "The name of the runtime to use. Currently, the only allowed value is `APPSYNC_JS`.\n" }, "runtimeVersion": { "type": "string", "description": "The version of the runtime to use. Currently, the only allowed version is `1.0.0`.\n" } }, "type": "object", "required": [ "name", "runtimeVersion" ] }, "aws:appsync/ResolverSyncConfig:ResolverSyncConfig": { "properties": { "conflictDetection": { "type": "string", "description": "Conflict Detection strategy to use. Valid values are `NONE` and `VERSION`.\n" }, "conflictHandler": { "type": "string", "description": "Conflict Resolution strategy to perform in the event of a conflict. Valid values are `NONE`, `OPTIMISTIC_CONCURRENCY`, `AUTOMERGE`, and `LAMBDA`.\n" }, "lambdaConflictHandlerConfig": { "$ref": "#/types/aws:appsync/ResolverSyncConfigLambdaConflictHandlerConfig:ResolverSyncConfigLambdaConflictHandlerConfig", "description": "Lambda Conflict Handler Config when configuring `LAMBDA` as the Conflict Handler. See Lambda Conflict Handler Config.\n" } }, "type": "object" }, "aws:appsync/ResolverSyncConfigLambdaConflictHandlerConfig:ResolverSyncConfigLambdaConflictHandlerConfig": { "properties": { "lambdaConflictHandlerArn": { "type": "string", "description": "ARN for the Lambda function to use as the Conflict Handler.\n" } }, "type": "object" }, "aws:appsync/SourceApiAssociationSourceApiAssociationConfig:SourceApiAssociationSourceApiAssociationConfig": { "properties": { "mergeType": { "type": "string", "description": "Merge type. Valid values: `MANUAL_MERGE`, `AUTO_MERGE`\n" } }, "type": "object", "required": [ "mergeType" ] }, "aws:appsync/SourceApiAssociationTimeouts:SourceApiAssociationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:athena/CapacityReservationTimeouts:CapacityReservationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:athena/DatabaseAclConfiguration:DatabaseAclConfiguration": { "properties": { "s3AclOption": { "type": "string", "description": "Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.\n\n\u003e **NOTE:** When Athena queries are executed, result files may be created in the specified bucket. Consider using `force_destroy` on the bucket too in order to avoid any problems when destroying the bucket.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "s3AclOption" ] }, "aws:athena/DatabaseEncryptionConfiguration:DatabaseEncryptionConfiguration": { "properties": { "encryptionOption": { "type": "string", "description": "Type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`\n", "willReplaceOnChanges": true }, "kmsKey": { "type": "string", "description": "KMS key ARN or ID; required for key types `SSE_KMS` and `CSE_KMS`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "encryptionOption" ] }, "aws:athena/WorkgroupConfiguration:WorkgroupConfiguration": { "properties": { "bytesScannedCutoffPerQuery": { "type": "integer", "description": "Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.\n" }, "enforceWorkgroupConfiguration": { "type": "boolean", "description": "Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.\n" }, "engineVersion": { "$ref": "#/types/aws:athena/WorkgroupConfigurationEngineVersion:WorkgroupConfigurationEngineVersion", "description": "Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.\n" }, "executionRole": { "type": "string", "description": "Role used in a notebook session for accessing the user's resources.\n" }, "publishCloudwatchMetricsEnabled": { "type": "boolean", "description": "Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.\n" }, "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.\n" }, "resultConfiguration": { "$ref": "#/types/aws:athena/WorkgroupConfigurationResultConfiguration:WorkgroupConfigurationResultConfiguration", "description": "Configuration block with result settings. See Result Configuration below.\n" } }, "type": "object" }, "aws:athena/WorkgroupConfigurationEngineVersion:WorkgroupConfigurationEngineVersion": { "properties": { "effectiveEngineVersion": { "type": "string", "description": "The engine version on which the query runs. If `selected_engine_version` is set to `AUTO`, the effective engine version is chosen by Athena.\n" }, "selectedEngineVersion": { "type": "string", "description": "Requested engine version. Defaults to `AUTO`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effectiveEngineVersion" ] } } }, "aws:athena/WorkgroupConfigurationResultConfiguration:WorkgroupConfigurationResultConfiguration": { "properties": { "aclConfiguration": { "$ref": "#/types/aws:athena/WorkgroupConfigurationResultConfigurationAclConfiguration:WorkgroupConfigurationResultConfigurationAclConfiguration", "description": "That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.\n" }, "encryptionConfiguration": { "$ref": "#/types/aws:athena/WorkgroupConfigurationResultConfigurationEncryptionConfiguration:WorkgroupConfigurationResultConfigurationEncryptionConfiguration", "description": "Configuration block with encryption settings. See Encryption Configuration below.\n" }, "expectedBucketOwner": { "type": "string", "description": "AWS account ID that you expect to be the owner of the Amazon S3 bucket.\n" }, "outputLocation": { "type": "string", "description": "Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).\n" } }, "type": "object" }, "aws:athena/WorkgroupConfigurationResultConfigurationAclConfiguration:WorkgroupConfigurationResultConfigurationAclConfiguration": { "properties": { "s3AclOption": { "type": "string", "description": "Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.\n" } }, "type": "object", "required": [ "s3AclOption" ] }, "aws:athena/WorkgroupConfigurationResultConfigurationEncryptionConfiguration:WorkgroupConfigurationResultConfigurationEncryptionConfiguration": { "properties": { "encryptionOption": { "type": "string", "description": "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. If 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.\n" }, "kmsKeyArn": { "type": "string", "description": "For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN.\n" } }, "type": "object" }, "aws:auditmanager/AssessmentAssessmentReportsDestination:AssessmentAssessmentReportsDestination": { "properties": { "destination": { "type": "string", "description": "Destination of the assessment report. This value be in the form `s3://{bucket_name}`.\n" }, "destinationType": { "type": "string", "description": "Destination type. Currently, `S3` is the only valid value.\n" } }, "type": "object", "required": [ "destination", "destinationType" ] }, "aws:auditmanager/AssessmentRole:AssessmentRole": { "properties": { "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the IAM role.\n" }, "roleType": { "type": "string", "description": "Type of customer persona. For assessment creation, type must always be `PROCESS_OWNER`.\n" } }, "type": "object", "required": [ "roleArn", "roleType" ] }, "aws:auditmanager/AssessmentRolesAll:AssessmentRolesAll": { "properties": { "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the IAM role.\n" }, "roleType": { "type": "string", "description": "Type of customer persona. For assessment creation, type must always be `PROCESS_OWNER`.\n" } }, "type": "object", "required": [ "roleArn", "roleType" ] }, "aws:auditmanager/AssessmentScope:AssessmentScope": { "properties": { "awsAccounts": { "type": "array", "items": { "$ref": "#/types/aws:auditmanager/AssessmentScopeAwsAccount:AssessmentScopeAwsAccount" }, "description": "Amazon Web Services accounts that are in scope for the assessment. See `aws_accounts` below.\n" }, "awsServices": { "type": "array", "items": { "$ref": "#/types/aws:auditmanager/AssessmentScopeAwsService:AssessmentScopeAwsService" }, "description": "Amazon Web Services services that are included in the scope of the assessment. See `aws_services` below.\n" } }, "type": "object" }, "aws:auditmanager/AssessmentScopeAwsAccount:AssessmentScopeAwsAccount": { "properties": { "id": { "type": "string", "description": "Identifier for the Amazon Web Services account.\n" } }, "type": "object", "required": [ "id" ] }, "aws:auditmanager/AssessmentScopeAwsService:AssessmentScopeAwsService": { "properties": { "serviceName": { "type": "string", "description": "Name of the Amazon Web Service.\n" } }, "type": "object", "required": [ "serviceName" ] }, "aws:auditmanager/ControlControlMappingSource:ControlControlMappingSource": { "properties": { "sourceDescription": { "type": "string", "description": "Description of the source.\n" }, "sourceFrequency": { "type": "string", "description": "Frequency of evidence collection. Valid values are `DAILY`, `WEEKLY`, or `MONTHLY`.\n" }, "sourceId": { "type": "string" }, "sourceKeyword": { "$ref": "#/types/aws:auditmanager/ControlControlMappingSourceSourceKeyword:ControlControlMappingSourceSourceKeyword", "description": "The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. See `source_keyword` below.\n" }, "sourceName": { "type": "string", "description": "Name of the source.\n" }, "sourceSetUpOption": { "type": "string", "description": "The setup option for the data source. This option reflects if the evidence collection is automated or manual. Valid values are `System_Controls_Mapping` (automated) and `Procedural_Controls_Mapping` (manual).\n" }, "sourceType": { "type": "string", "description": "Type of data source for evidence collection. If `source_set_up_option` is manual, the only valid value is `MANUAL`. If `source_set_up_option` is automated, valid values are `AWS_Cloudtrail`, `AWS_Config`, `AWS_Security_Hub`, or `AWS_API_Call`.\n\nThe following arguments are optional:\n" }, "troubleshootingText": { "type": "string", "description": "Instructions for troubleshooting the control.\n" } }, "type": "object", "required": [ "sourceName", "sourceSetUpOption", "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "sourceId", "sourceName", "sourceSetUpOption", "sourceType" ] } } }, "aws:auditmanager/ControlControlMappingSourceSourceKeyword:ControlControlMappingSourceSourceKeyword": { "properties": { "keywordInputType": { "type": "string", "description": "Input method for the keyword. Valid values are `INPUT_TEXT`, `SELECT_FROM_LIST`, or `UPLOAD_FILE`.\n" }, "keywordValue": { "type": "string", "description": "The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. See the [Audit Manager supported control data sources documentation](https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources.html) for more information.\n" } }, "type": "object", "required": [ "keywordInputType", "keywordValue" ] }, "aws:auditmanager/FrameworkControlSet:FrameworkControlSet": { "properties": { "controls": { "type": "array", "items": { "$ref": "#/types/aws:auditmanager/FrameworkControlSetControl:FrameworkControlSetControl" }, "description": "Configuration block(s) for the controls within the control set. See `controls` Block below for details.\n" }, "id": { "type": "string", "description": "Unique identifier for the framework.\n" }, "name": { "type": "string", "description": "Name of the control set.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "id", "name" ] } } }, "aws:auditmanager/FrameworkControlSetControl:FrameworkControlSetControl": { "properties": { "id": { "type": "string", "description": "Unique identifier of the control.\n" } }, "type": "object", "required": [ "id" ] }, "aws:auditmanager/getControlControlMappingSource:getControlControlMappingSource": { "properties": { "sourceDescription": { "type": "string" }, "sourceFrequency": { "type": "string" }, "sourceId": { "type": "string" }, "sourceKeyword": { "$ref": "#/types/aws:auditmanager/getControlControlMappingSourceSourceKeyword:getControlControlMappingSourceSourceKeyword" }, "sourceName": { "type": "string" }, "sourceSetUpOption": { "type": "string" }, "sourceType": { "type": "string" }, "troubleshootingText": { "type": "string" } }, "type": "object", "required": [ "sourceDescription", "sourceFrequency", "sourceId", "sourceName", "sourceSetUpOption", "sourceType", "troubleshootingText" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:auditmanager/getControlControlMappingSourceSourceKeyword:getControlControlMappingSourceSourceKeyword": { "properties": { "keywordInputType": { "type": "string" }, "keywordValue": { "type": "string" } }, "type": "object", "required": [ "keywordInputType", "keywordValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:auditmanager/getFrameworkControlSet:getFrameworkControlSet": { "properties": { "controls": { "type": "array", "items": { "$ref": "#/types/aws:auditmanager/getFrameworkControlSetControl:getFrameworkControlSetControl" } }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the framework.\n" } }, "type": "object", "required": [ "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:auditmanager/getFrameworkControlSetControl:getFrameworkControlSetControl": { "properties": { "id": { "type": "string" } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/GroupAvailabilityZoneDistribution:GroupAvailabilityZoneDistribution": { "properties": { "capacityDistributionStrategy": { "type": "string", "description": "The strategy to use for distributing capacity across the Availability Zones. Valid values are `balanced-only` and `balanced-best-effort`. Default is `balanced-best-effort`.\n" } }, "type": "object" }, "aws:autoscaling/GroupInitialLifecycleHook:GroupInitialLifecycleHook": { "properties": { "defaultResult": { "type": "string", "willReplaceOnChanges": true }, "heartbeatTimeout": { "type": "integer", "willReplaceOnChanges": true }, "lifecycleTransition": { "type": "string", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the Auto Scaling Group. By default generated by Pulumi. Conflicts with `name_prefix`.\n", "willReplaceOnChanges": true }, "notificationMetadata": { "type": "string", "willReplaceOnChanges": true }, "notificationTargetArn": { "type": "string", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "lifecycleTransition", "name" ], "language": { "nodejs": { "requiredOutputs": [ "defaultResult", "lifecycleTransition", "name" ] } } }, "aws:autoscaling/GroupInstanceMaintenancePolicy:GroupInstanceMaintenancePolicy": { "properties": { "maxHealthyPercentage": { "type": "integer", "description": "Specifies the upper limit on the number of instances that are in the InService or Pending state with a healthy status during an instance replacement activity.\n" }, "minHealthyPercentage": { "type": "integer", "description": "Specifies the lower limit on the number of instances that must be in the InService state with a healthy status during an instance replacement activity.\n" } }, "type": "object", "required": [ "maxHealthyPercentage", "minHealthyPercentage" ] }, "aws:autoscaling/GroupInstanceRefresh:GroupInstanceRefresh": { "properties": { "preferences": { "$ref": "#/types/aws:autoscaling/GroupInstanceRefreshPreferences:GroupInstanceRefreshPreferences", "description": "Override default parameters for Instance Refresh.\n" }, "strategy": { "type": "string", "description": "Strategy to use for instance refresh. The only allowed value is `Rolling`. See [StartInstanceRefresh Action](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_StartInstanceRefresh.html#API_StartInstanceRefresh_RequestParameters) for more information.\n" }, "triggers": { "type": "array", "items": { "type": "string" }, "description": "Set of additional property names that will trigger an Instance Refresh. A refresh will always be triggered by a change in any of `launch_configuration`, `launch_template`, or `mixed_instances_policy`.\n\n\u003e **NOTE:** A refresh is started when any of the following Auto Scaling Group properties change: `launch_configuration`, `launch_template`, `mixed_instances_policy`. Additional properties can be specified in the `triggers` property of `instance_refresh`.\n\n\u003e **NOTE:** A refresh will not start when `version = \"$Latest\"` is configured in the `launch_template` block. To trigger the instance refresh when a launch template is changed, configure `version` to use the `latest_version` attribute of the `aws.ec2.LaunchTemplate` resource.\n\n\u003e **NOTE:** Auto Scaling Groups support up to one active instance refresh at a time. When this resource is updated, any existing refresh is cancelled.\n\n\u003e **NOTE:** Depending on health check settings and group size, an instance refresh may take a long time or fail. This resource does not wait for the instance refresh to complete.\n" } }, "type": "object", "required": [ "strategy" ] }, "aws:autoscaling/GroupInstanceRefreshPreferences:GroupInstanceRefreshPreferences": { "properties": { "alarmSpecification": { "$ref": "#/types/aws:autoscaling/GroupInstanceRefreshPreferencesAlarmSpecification:GroupInstanceRefreshPreferencesAlarmSpecification", "description": "Alarm Specification for Instance Refresh.\n" }, "autoRollback": { "type": "boolean", "description": "Automatically rollback if instance refresh fails. Defaults to `false`. This option may only be set to `true` when specifying a `launch_template` or `mixed_instances_policy`.\n" }, "checkpointDelay": { "type": "string", "description": "Number of seconds to wait after a checkpoint. Defaults to `3600`.\n" }, "checkpointPercentages": { "type": "array", "items": { "type": "integer" }, "description": "List of percentages for each checkpoint. Values must be unique and in ascending order. To replace all instances, the final number must be `100`.\n" }, "instanceWarmup": { "type": "string", "description": "Number of seconds until a newly launched instance is configured and ready to use. Default behavior is to use the Auto Scaling Group's health check grace period.\n" }, "maxHealthyPercentage": { "type": "integer", "description": "Amount of capacity in the Auto Scaling group that can be in service and healthy, or pending, to support your workload when an instance refresh is in place, as a percentage of the desired capacity of the Auto Scaling group. Values must be between `100` and `200`, defaults to `100`.\n" }, "minHealthyPercentage": { "type": "integer", "description": "Amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue, as a percentage of the desired capacity of the Auto Scaling group. Defaults to `90`.\n" }, "scaleInProtectedInstances": { "type": "string", "description": "Behavior when encountering instances protected from scale in are found. Available behaviors are `Refresh`, `Ignore`, and `Wait`. Default is `Ignore`.\n" }, "skipMatching": { "type": "boolean", "description": "Replace instances that already have your desired configuration. Defaults to `false`.\n" }, "standbyInstances": { "type": "string", "description": "Behavior when encountering instances in the `Standby` state in are found. Available behaviors are `Terminate`, `Ignore`, and `Wait`. Default is `Ignore`.\n" } }, "type": "object" }, "aws:autoscaling/GroupInstanceRefreshPreferencesAlarmSpecification:GroupInstanceRefreshPreferencesAlarmSpecification": { "properties": { "alarms": { "type": "array", "items": { "type": "string" }, "description": "List of Cloudwatch alarms. If any of these alarms goes into ALARM state, Instance Refresh is failed.\n" } }, "type": "object" }, "aws:autoscaling/GroupLaunchTemplate:GroupLaunchTemplate": { "properties": { "id": { "type": "string", "description": "ID of the launch template. Conflicts with `name`.\n" }, "name": { "type": "string", "description": "Name of the launch template. Conflicts with `id`.\n" }, "version": { "type": "string", "description": "Template version. Can be version number, `$Latest`, or `$Default`. (Default: `$Default`).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "name", "version" ] } } }, "aws:autoscaling/GroupMixedInstancesPolicy:GroupMixedInstancesPolicy": { "properties": { "instancesDistribution": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyInstancesDistribution:GroupMixedInstancesPolicyInstancesDistribution", "description": "Nested argument containing settings on how to mix on-demand and Spot instances in the Auto Scaling group. Defined below.\n" }, "launchTemplate": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplate:GroupMixedInstancesPolicyLaunchTemplate", "description": "Nested argument containing launch template settings along with the overrides to specify multiple instance types and weights. Defined below.\n" } }, "type": "object", "required": [ "launchTemplate" ], "language": { "nodejs": { "requiredOutputs": [ "instancesDistribution", "launchTemplate" ] } } }, "aws:autoscaling/GroupMixedInstancesPolicyInstancesDistribution:GroupMixedInstancesPolicyInstancesDistribution": { "properties": { "onDemandAllocationStrategy": { "type": "string", "description": "Strategy to use when launching on-demand instances. Valid values: `prioritized`, `lowest-price`. Default: `prioritized`.\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Absolute minimum amount of desired capacity that must be fulfilled by on-demand instances. Default: `0`.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Percentage split between on-demand and Spot instances above the base on-demand capacity. Default: `100`.\n" }, "spotAllocationStrategy": { "type": "string", "description": "How to allocate capacity across the Spot pools. Valid values: `lowest-price`, `capacity-optimized`, `capacity-optimized-prioritized`, and `price-capacity-optimized`. Default: `lowest-price`.\n" }, "spotInstancePools": { "type": "integer", "description": "Number of Spot pools per availability zone to allocate capacity. EC2 Auto Scaling selects the cheapest Spot pools and evenly allocates Spot capacity across the number of Spot pools that you specify. Only available with `spot_allocation_strategy` set to `lowest-price`. Otherwise it must be set to `0`, if it has been defined before. Default: `2`.\n" }, "spotMaxPrice": { "type": "string", "description": "Maximum price per unit hour that the user is willing to pay for the Spot instances. Default: an empty string which means the on-demand price.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "onDemandAllocationStrategy", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity", "spotAllocationStrategy", "spotInstancePools" ] } } }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplate:GroupMixedInstancesPolicyLaunchTemplate": { "properties": { "launchTemplateSpecification": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification:GroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification", "description": "Override the instance launch template specification in the Launch Template.\n" }, "overrides": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverride:GroupMixedInstancesPolicyLaunchTemplateOverride" }, "description": "List of nested arguments provides the ability to specify multiple instance types. This will override the same parameter in the launch template. For on-demand instances, Auto Scaling considers the order of preference of instance types to launch based on the order specified in the overrides list. Defined below.\n" } }, "type": "object", "required": [ "launchTemplateSpecification" ], "language": { "nodejs": { "requiredOutputs": [ "launchTemplateSpecification", "overrides" ] } } }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification:GroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the launch template. Conflicts with `launch_template_name`.\n" }, "launchTemplateName": { "type": "string", "description": "Name of the launch template. Conflicts with `launch_template_id`.\n" }, "version": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "launchTemplateId", "launchTemplateName", "version" ] } } }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverride:GroupMixedInstancesPolicyLaunchTemplateOverride": { "properties": { "instanceRequirements": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements", "description": "Override the instance type in the Launch Template with instance types that satisfy the requirements.\n" }, "instanceType": { "type": "string", "description": "Override the instance type in the Launch Template.\n" }, "launchTemplateSpecification": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification:GroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification", "description": "Override the instance launch template specification in the Launch Template.\n" }, "weightedCapacity": { "type": "string", "description": "Number of capacity units, which gives the instance type a proportional weight to other instance types.\n" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements": { "properties": { "acceleratorCount": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorCount", "description": "Block describing the minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips). Default is no minimum or maximum.\n" }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator manufacturer names. Default is any manufacturer.\n\n```\nValid names:\n* amazon-web-services\n* amd\n* nvidia\n* xilinx\n```\n" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator names. Default is any acclerator.\n\n```\nValid names:\n* a100 - NVIDIA A100 GPUs\n* v100 - NVIDIA V100 GPUs\n* k80 - NVIDIA K80 GPUs\n* t4 - NVIDIA T4 GPUs\n* m60 - NVIDIA M60 GPUs\n* radeon-pro-v520 - AMD Radeon Pro V520 GPUs\n* vu9p - Xilinx VU9P FPGAs\n```\n" }, "acceleratorTotalMemoryMib": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorTotalMemoryMib:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorTotalMemoryMib", "description": "Block describing the minimum and maximum total memory of the accelerators. Default is no minimum or maximum.\n" }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator types. Default is any accelerator type.\n\n```\nValid types:\n* fpga\n* gpu\n* inference\n```\n" }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. 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*`. For example, if you specify `c5*`, you are allowing the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, you are allowing all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is all instance types.\n\n\u003e **NOTE:** If you specify `allowed_instance_types`, you can't specify `excluded_instance_types`.\n" }, "bareMetal": { "type": "string", "description": "Indicate whether bare metal instace types should be `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "baselineEbsBandwidthMbps": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsBaselineEbsBandwidthMbps:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsBaselineEbsBandwidthMbps", "description": "Block describing the minimum and maximum baseline EBS bandwidth, in Mbps. Default is no minimum or maximum.\n" }, "burstablePerformance": { "type": "string", "description": "Indicate whether burstable performance instance types should be `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of CPU manufacturer names. Default is any manufacturer.\n\n\u003e **NOTE:** 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\n```\nValid names:\n* amazon-web-services\n* amd\n* intel\n```\n" }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to exclude. 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*`. 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.*`, you are excluding all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is no excluded instance types.\n\n\u003e **NOTE:** If you specify `excluded_instance_types`, you can't specify `allowed_instance_types`.\n" }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "List of instance generation names. Default is any generation.\n\n```\nValid names:\n* current - Recommended for best performance.\n* previous - For existing applications optimized for older instance types.\n```\n" }, "localStorage": { "type": "string", "description": "Indicate whether instance types with local storage volumes are `included`, `excluded`, or `required`. Default is `included`.\n" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "List of local storage type names. Default any storage type.\n\n```\nValue names:\n* hdd - hard disk drive\n* ssd - solid state drive\n```\n" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Conflicts with `spot_max_price_percentage_over_lowest_price`\n" }, "memoryGibPerVcpu": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryGibPerVcpu:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryGibPerVcpu", "description": "Block describing the minimum and maximum amount of memory (GiB) per vCPU. Default is no minimum or maximum.\n" }, "memoryMib": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryMib:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryMib", "description": "Block describing the minimum and maximum amount of memory (MiB). Default is no maximum.\n" }, "networkBandwidthGbps": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkBandwidthGbps:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkBandwidthGbps", "description": "Block describing the minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default is no minimum or maximum.\n" }, "networkInterfaceCount": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkInterfaceCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkInterfaceCount", "description": "Block describing the minimum and maximum number of network interfaces. Default is no minimum or maximum.\n" }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "Price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 20.\n\nIf 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" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicate whether instance types must support On-Demand Instance Hibernation, either `true` or `false`. Default is `false`.\n" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "Price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 100. Conflicts with `max_spot_price_as_percentage_of_optimal_on_demand_price`\n\nIf 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" }, "totalLocalStorageGb": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsTotalLocalStorageGb:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsTotalLocalStorageGb", "description": "Block describing the minimum and maximum total local storage (GB). Default is no minimum or maximum.\n" }, "vcpuCount": { "$ref": "#/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsVcpuCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsVcpuCount", "description": "Block describing the minimum and maximum number of vCPUs. Default is no maximum.\n" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorTotalMemoryMib:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsBaselineEbsBandwidthMbps:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsBaselineEbsBandwidthMbps": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryGibPerVcpu:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryGibPerVcpu": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryMib:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsMemoryMib": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkBandwidthGbps:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkBandwidthGbps": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkInterfaceCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsNetworkInterfaceCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsTotalLocalStorageGb:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsTotalLocalStorageGb": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsVcpuCount:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementsVcpuCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification:GroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the launch template. Conflicts with `launch_template_name`.\n" }, "launchTemplateName": { "type": "string", "description": "Name of the launch template. Conflicts with `launch_template_id`.\n" }, "version": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "launchTemplateId", "launchTemplateName", "version" ] } } }, "aws:autoscaling/GroupTag:GroupTag": { "properties": { "key": { "type": "string", "description": "Key\n" }, "propagateAtLaunch": { "type": "boolean", "description": "Enables propagation of the tag to\nAmazon EC2 instances launched via this ASG\n\nTo declare multiple tags, additional `tag` blocks can be specified.\n\n\u003e **NOTE:** Other AWS APIs may automatically add special tags to their associated Auto Scaling Group for management purposes, such as ECS Capacity Providers adding the `AmazonECSManaged` tag. These generally should be included in the configuration so the provider does not attempt to remove them and so if the `min_size` was greater than zero on creation, that these tag(s) are applied to any initial EC2 Instances in the Auto Scaling Group. If these tag(s) were missing in the Auto Scaling Group configuration on creation, affected EC2 Instances missing the tags may require manual intervention of adding the tags to ensure they work properly with the other AWS service.\n" }, "value": { "type": "string", "description": "Value\n" } }, "type": "object", "required": [ "key", "propagateAtLaunch", "value" ] }, "aws:autoscaling/GroupTrafficSource:GroupTrafficSource": { "properties": { "identifier": { "type": "string", "description": "Identifies the traffic source. 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" }, "type": { "type": "string", "description": "Provides additional context for the value of Identifier.\nThe 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" } }, "type": "object", "required": [ "identifier" ] }, "aws:autoscaling/GroupWarmPool:GroupWarmPool": { "properties": { "instanceReusePolicy": { "$ref": "#/types/aws:autoscaling/GroupWarmPoolInstanceReusePolicy:GroupWarmPoolInstanceReusePolicy", "description": "Whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.\n" }, "maxGroupPreparedCapacity": { "type": "integer", "description": "Total maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.\n" }, "minSize": { "type": "integer", "description": "Minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.\n" }, "poolState": { "type": "string", "description": "Sets the instance state to transition to after the lifecycle hooks finish. Valid values are: Stopped (default), Running or Hibernated.\n" } }, "type": "object" }, "aws:autoscaling/GroupWarmPoolInstanceReusePolicy:GroupWarmPoolInstanceReusePolicy": { "properties": { "reuseOnScaleIn": { "type": "boolean", "description": "Whether instances in the Auto Scaling group can be returned to the warm pool on scale in.\n" } }, "type": "object" }, "aws:autoscaling/Metric:Metric": { "description": "See https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html", "type": "string", "enum": [ { "value": "GroupMinSize" }, { "value": "GroupMaxSize" }, { "value": "GroupDesiredCapacity" }, { "value": "GroupInServiceInstances" }, { "value": "GroupInServiceCapacity" }, { "value": "GroupPendingInstances" }, { "value": "GroupPendingCapacity" }, { "value": "GroupStandbyInstances" }, { "value": "GroupStandbyCapacity" }, { "value": "GroupTerminatingInstances" }, { "value": "GroupTerminatingCapacity" }, { "value": "GroupTotalInstances" }, { "value": "GroupTotalCapacity" }, { "value": "WarmPoolDesiredCapacity" }, { "value": "WarmPoolWarmedCapacity" }, { "value": "WarmPoolPendingCapacity" }, { "value": "WarmPoolTerminatingCapacity" }, { "value": "WarmPoolTotalCapacity" }, { "value": "GroupAndWarmPoolDesiredCapacity" }, { "value": "GroupAndWarmPoolTotalCapacity" } ] }, "aws:autoscaling/MetricsGranularity:MetricsGranularity": { "description": "See https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html", "type": "string", "enum": [ { "name": "OneMinute", "value": "1Minute" } ] }, "aws:autoscaling/NotificationType:NotificationType": { "description": "See https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_NotificationConfiguration.html", "type": "string", "enum": [ { "name": "InstanceLaunch", "value": "autoscaling:EC2_INSTANCE_LAUNCH" }, { "name": "InstanceTerminate", "value": "autoscaling:EC2_INSTANCE_TERMINATE" }, { "name": "InstanceLaunchError", "value": "autoscaling:EC2_INSTANCE_LAUNCH_ERROR" }, { "name": "InstanceTerminateError", "value": "autoscaling:EC2_INSTANCE_TERMINATE_ERROR" }, { "name": "TestNotification", "value": "autoscaling:TEST_NOTIFICATION" } ] }, "aws:autoscaling/PolicyPredictiveScalingConfiguration:PolicyPredictiveScalingConfiguration": { "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. Valid values are `HonorMaxCapacity` or `IncreaseMaxCapacity`. Default is `HonorMaxCapacity`.\n" }, "maxCapacityBuffer": { "type": "string", "description": "Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. Valid range is `0` to `100`. If set to `0`, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.\n" }, "metricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecification", "description": "This structure includes the metrics and target utilization to use for predictive scaling.\n" }, "mode": { "type": "string", "description": "Predictive scaling mode. Valid values are `ForecastAndScale` and `ForecastOnly`. Default is `ForecastOnly`.\n" }, "schedulingBufferTime": { "type": "string", "description": "Amount of time, in seconds, by which the instance launch time can be advanced. Minimum is `0`.\n" } }, "type": "object", "required": [ "metricSpecification" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecification": { "properties": { "customizedCapacityMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecification", "description": "Customized capacity metric specification. The field is only valid when you use `customized_load_metric_specification`\n" }, "customizedLoadMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecification", "description": "Customized load metric specification.\n" }, "customizedScalingMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecification", "description": "Customized scaling metric specification.\n" }, "predefinedLoadMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedLoadMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedLoadMetricSpecification", "description": "Predefined load metric specification.\n" }, "predefinedMetricPairSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedMetricPairSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedMetricPairSpecification", "description": "Metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.\n" }, "predefinedScalingMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedScalingMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedScalingMetricSpecification", "description": "Predefined scaling metric specification.\n" }, "targetValue": { "type": "number", "description": "Target value for the metric.\n" } }, "type": "object", "required": [ "targetValue" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecification": { "properties": { "metricDataQueries": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQuery" }, "description": "List of up to 10 structures that defines custom capacity metric in predictive scaling policy\n" } }, "type": "object", "required": [ "metricDataQueries" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQuery": { "properties": { "expression": { "type": "string", "description": "Math expression used on the returned metric. You must specify either `expression` or `metric_stat`, but not both.\n" }, "id": { "type": "string", "description": "Short name for the metric used in predictive scaling policy.\n" }, "label": { "type": "string", "description": "Human-readable label for this metric or expression.\n" }, "metricStat": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStat", "description": "Structure that defines CloudWatch metric to be used in predictive scaling policy. You must specify either `expression` or `metric_stat`, but not both.\n" }, "returnData": { "type": "boolean", "description": "Boolean that indicates whether to return the timestamps and raw data values of this metric, the default is true\n" } }, "type": "object", "required": [ "id" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStat": { "properties": { "metric": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetric", "description": "Structure that defines the CloudWatch metric to return, including the metric name, namespace, and dimensions.\n" }, "stat": { "type": "string", "description": "Statistic of the metrics to return.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object", "required": [ "metric", "stat" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetric": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedCapacityMetricSpecificationMetricDataQueryMetricStatMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecification": { "properties": { "metricDataQueries": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQuery" }, "description": "List of up to 10 structures that defines custom load metric in predictive scaling policy\n" } }, "type": "object", "required": [ "metricDataQueries" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQuery": { "properties": { "expression": { "type": "string", "description": "Math expression used on the returned metric. You must specify either `expression` or `metric_stat`, but not both.\n" }, "id": { "type": "string", "description": "Short name for the metric used in predictive scaling policy.\n" }, "label": { "type": "string", "description": "Human-readable label for this metric or expression.\n" }, "metricStat": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStat", "description": "Structure that defines CloudWatch metric to be used in predictive scaling policy. You must specify either `expression` or `metric_stat`, but not both.\n" }, "returnData": { "type": "boolean", "description": "Boolean that indicates whether to return the timestamps and raw data values of this metric, the default is true\n" } }, "type": "object", "required": [ "id" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStat": { "properties": { "metric": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetric", "description": "Structure that defines the CloudWatch metric to return, including the metric name, namespace, and dimensions.\n" }, "stat": { "type": "string", "description": "Statistic of the metrics to return.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object", "required": [ "metric", "stat" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetric": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedLoadMetricSpecificationMetricDataQueryMetricStatMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecification": { "properties": { "metricDataQueries": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQuery" }, "description": "List of up to 10 structures that defines custom scaling metric in predictive scaling policy\n" } }, "type": "object", "required": [ "metricDataQueries" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQuery:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQuery": { "properties": { "expression": { "type": "string", "description": "Math expression used on the returned metric. You must specify either `expression` or `metric_stat`, but not both.\n" }, "id": { "type": "string", "description": "Short name for the metric used in predictive scaling policy.\n" }, "label": { "type": "string", "description": "Human-readable label for this metric or expression.\n" }, "metricStat": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStat", "description": "Structure that defines CloudWatch metric to be used in predictive scaling policy. You must specify either `expression` or `metric_stat`, but not both.\n" }, "returnData": { "type": "boolean", "description": "Boolean that indicates whether to return the timestamps and raw data values of this metric, the default is true\n" } }, "type": "object", "required": [ "id" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStat:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStat": { "properties": { "metric": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetric", "description": "Structure that defines the CloudWatch metric to return, including the metric name, namespace, and dimensions.\n" }, "stat": { "type": "string", "description": "Statistic of the metrics to return.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object", "required": [ "metric", "stat" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetric:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetric": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetricDimension:PolicyPredictiveScalingConfigurationMetricSpecificationCustomizedScalingMetricSpecificationMetricDataQueryMetricStatMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedLoadMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedLoadMetricSpecification": { "properties": { "predefinedMetricType": { "type": "string", "description": "Metric type. Valid values are `ASGTotalCPUUtilization`, `ASGTotalNetworkIn`, `ASGTotalNetworkOut`, or `ALBTargetGroupRequestCount`.\n" }, "resourceLabel": { "type": "string", "description": "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 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 (/). Refer to [PredefinedMetricSpecification](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredefinedMetricSpecification.html) for more information.\n" } }, "type": "object", "required": [ "predefinedMetricType" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedMetricPairSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedMetricPairSpecification": { "properties": { "predefinedMetricType": { "type": "string", "description": "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. Valid values are `ASGCPUUtilization`, `ASGNetworkIn`, `ASGNetworkOut`, or `ALBRequestCount`.\n" }, "resourceLabel": { "type": "string", "description": "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 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 (/). Refer to [PredefinedMetricSpecification](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredefinedMetricSpecification.html) for more information.\n" } }, "type": "object", "required": [ "predefinedMetricType" ] }, "aws:autoscaling/PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedScalingMetricSpecification:PolicyPredictiveScalingConfigurationMetricSpecificationPredefinedScalingMetricSpecification": { "properties": { "predefinedMetricType": { "type": "string", "description": "Describes a scaling metric for a predictive scaling policy. Valid values are `ASGAverageCPUUtilization`, `ASGAverageNetworkIn`, `ASGAverageNetworkOut`, or `ALBRequestCountPerTarget`.\n" }, "resourceLabel": { "type": "string", "description": "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 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 (/). Refer to [PredefinedMetricSpecification](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredefinedMetricSpecification.html) for more information.\n" } }, "type": "object", "required": [ "predefinedMetricType" ] }, "aws:autoscaling/PolicyStepAdjustment:PolicyStepAdjustment": { "properties": { "metricIntervalLowerBound": { "type": "string", "description": "Lower bound for the\ndifference between the alarm threshold and the CloudWatch metric.\nWithout a value, AWS will treat this bound as negative infinity.\n" }, "metricIntervalUpperBound": { "type": "string", "description": "Upper bound for the\ndifference between the alarm threshold and the CloudWatch metric.\nWithout a value, AWS will treat this bound as positive infinity. The upper bound\nmust be greater than the lower bound.\n\nNotice the bounds are **relative** to the alarm threshold, meaning that the starting point is not 0%, but the alarm threshold. Check the official [docs](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) for a detailed example.\n\nThe following arguments are only available to \"TargetTrackingScaling\" type policies:\n" }, "scalingAdjustment": { "type": "integer", "description": "Number of members by which to\nscale, when the adjustment bounds are breached. A positive value scales\nup. A negative value scales down.\n" } }, "type": "object", "required": [ "scalingAdjustment" ] }, "aws:autoscaling/PolicyTargetTrackingConfiguration:PolicyTargetTrackingConfiguration": { "properties": { "customizedMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecification:PolicyTargetTrackingConfigurationCustomizedMetricSpecification", "description": "Customized metric. Conflicts with `predefined_metric_specification`.\n" }, "disableScaleIn": { "type": "boolean", "description": "Whether scale in by the target tracking policy is disabled.\n" }, "predefinedMetricSpecification": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationPredefinedMetricSpecification:PolicyTargetTrackingConfigurationPredefinedMetricSpecification", "description": "Predefined metric. Conflicts with `customized_metric_specification`.\n" }, "targetValue": { "type": "number", "description": "Target value for the metric.\n" } }, "type": "object", "required": [ "targetValue" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecification:PolicyTargetTrackingConfigurationCustomizedMetricSpecification": { "properties": { "metricDimensions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricDimension:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetric:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetric" }, "description": "Metrics to include, as a metric data query.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" }, "period": { "type": "integer", "description": "The period of the metric in seconds.\n" }, "statistic": { "type": "string", "description": "Statistic of the metric.\n" }, "unit": { "type": "string", "description": "Unit of the metric.\n" } }, "type": "object" }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetric:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetric": { "properties": { "expression": { "type": "string", "description": "Math expression used on the returned metric. You must specify either `expression` or `metric_stat`, but not both.\n" }, "id": { "type": "string", "description": "Short name for the metric used in target tracking scaling policy.\n" }, "label": { "type": "string", "description": "Human-readable label for this metric or expression.\n" }, "metricStat": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStat:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStat", "description": "Structure that defines CloudWatch metric to be used in target tracking scaling policy. You must specify either `expression` or `metric_stat`, but not both.\n" }, "returnData": { "type": "boolean", "description": "Boolean that indicates whether to return the timestamps and raw data values of this metric, the default is true\n" } }, "type": "object", "required": [ "id" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricDimension:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStat:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStat": { "properties": { "metric": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetric:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetric", "description": "Structure that defines the CloudWatch metric to return, including the metric name, namespace, and dimensions.\n" }, "period": { "type": "integer", "description": "The period of the metric in seconds.\n" }, "stat": { "type": "string", "description": "Statistic of the metrics to return.\n" }, "unit": { "type": "string", "description": "Unit of the metrics to return.\n" } }, "type": "object", "required": [ "metric", "stat" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetric:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetric": { "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension:PolicyTargetTrackingConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimension": { "properties": { "name": { "type": "string", "description": "Name of the dimension.\n" }, "value": { "type": "string", "description": "Value of the dimension.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:autoscaling/PolicyTargetTrackingConfigurationPredefinedMetricSpecification:PolicyTargetTrackingConfigurationPredefinedMetricSpecification": { "properties": { "predefinedMetricType": { "type": "string", "description": "Metric type.\n" }, "resourceLabel": { "type": "string", "description": "Identifies the resource associated with the metric type.\n" } }, "type": "object", "required": [ "predefinedMetricType" ] }, "aws:autoscaling/TagTag:TagTag": { "properties": { "key": { "type": "string", "description": "Tag name.\n", "willReplaceOnChanges": true }, "propagateAtLaunch": { "type": "boolean", "description": "Whether to propagate the tags to instances launched by the ASG.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "propagateAtLaunch", "value" ] }, "aws:autoscaling/TrafficSourceAttachmentTrafficSource:TrafficSourceAttachmentTrafficSource": { "properties": { "identifier": { "type": "string", "description": "Identifies the traffic source. 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", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Provides additional context for the value of `identifier`.\nThe 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", "willReplaceOnChanges": true } }, "type": "object", "required": [ "identifier", "type" ] }, "aws:autoscaling/getAmiIdsFilter:getAmiIdsFilter": { "properties": { "name": { "type": "string", "description": "Name of the DescribeAutoScalingGroup filter. The recommended values are: `tag-key`, `tag-value`, and `tag:\u003ctag name\u003e`\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Value of the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:autoscaling/getGroupInstanceMaintenancePolicy:getGroupInstanceMaintenancePolicy": { "properties": { "maxHealthyPercentage": { "type": "integer", "description": "Specifies the upper limit on the number of instances that are in the InService or Pending state with a healthy status during an instance replacement activity.\n" }, "minHealthyPercentage": { "type": "integer", "description": "Specifies the lower limit on the number of instances that must be in the InService state with a healthy status during an instance replacement activity.\n" } }, "type": "object", "required": [ "maxHealthyPercentage", "minHealthyPercentage" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupLaunchTemplate:getGroupLaunchTemplate": { "properties": { "id": { "type": "string", "description": "ID of the launch template.\n" }, "name": { "type": "string", "description": "Specify the exact name of the desired autoscaling group.\n" }, "version": { "type": "string", "description": "Template version.\n" } }, "type": "object", "required": [ "id", "name", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicy:getGroupMixedInstancesPolicy": { "properties": { "instancesDistributions": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyInstancesDistribution:getGroupMixedInstancesPolicyInstancesDistribution" }, "description": "List of instances distribution objects.\n" }, "launchTemplates": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplate:getGroupMixedInstancesPolicyLaunchTemplate" }, "description": "List of launch templates along with the overrides.\n" } }, "type": "object", "required": [ "instancesDistributions", "launchTemplates" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyInstancesDistribution:getGroupMixedInstancesPolicyInstancesDistribution": { "properties": { "onDemandAllocationStrategy": { "type": "string", "description": "Strategy used when launching on-demand instances.\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Absolute minimum amount of desired capacity that must be fulfilled by on-demand instances.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer" }, "spotAllocationStrategy": { "type": "string", "description": "Strategy used when launching Spot instances.\n" }, "spotInstancePools": { "type": "integer", "description": "Number of Spot pools per availability zone to allocate capacity.\n" }, "spotMaxPrice": { "type": "string", "description": "Maximum price per unit hour that the user is willing to pay for the Spot instances.\n" } }, "type": "object", "required": [ "onDemandAllocationStrategy", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity", "spotAllocationStrategy", "spotInstancePools", "spotMaxPrice" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplate:getGroupMixedInstancesPolicyLaunchTemplate": { "properties": { "launchTemplateSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification:getGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification" }, "description": "List of overriding launch template specification objects.\n" }, "overrides": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverride:getGroupMixedInstancesPolicyLaunchTemplateOverride" }, "description": "List of properties overriding the same properties in the launch template.\n" } }, "type": "object", "required": [ "launchTemplateSpecifications", "overrides" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification:getGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the launch template.\n" }, "launchTemplateName": { "type": "string", "description": "Name of the launch template.\n" }, "version": { "type": "string", "description": "Template version.\n" } }, "type": "object", "required": [ "launchTemplateId", "launchTemplateName", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverride:getGroupMixedInstancesPolicyLaunchTemplateOverride": { "properties": { "instanceRequirements": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirement:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirement" }, "description": "List of instance requirements objects.\n* `accelerator_count - List of objects describing the minimum and maximum number of accelerators for an instance type.\n" }, "instanceType": { "type": "string", "description": "Overriding instance type.\n" }, "launchTemplateSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification:getGroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification" }, "description": "List of overriding launch template specification objects.\n" }, "weightedCapacity": { "type": "string", "description": "Number of capacity units, which gives the instance type a proportional weight to other instance types.\n" } }, "type": "object", "required": [ "instanceRequirements", "instanceType", "launchTemplateSpecifications", "weightedCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirement:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirement": { "properties": { "acceleratorCounts": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorCount" } }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator manufacturer names.\n" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator names.\n" }, "acceleratorTotalMemoryMibs": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorTotalMemoryMib:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorTotalMemoryMib" }, "description": "List of objects describing the minimum and maximum total memory of the accelerators.\n" }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator types.\n" }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to apply the specified attributes against.\n" }, "bareMetal": { "type": "string", "description": "Indicates whether bare metal instances are included, excluded, or required.\n" }, "baselineEbsBandwidthMbps": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementBaselineEbsBandwidthMbp:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementBaselineEbsBandwidthMbp" }, "description": "List of objects describing the minimum and maximum baseline EBS bandwidth (Mbps).\n" }, "burstablePerformance": { "type": "string", "description": "Indicates whether burstable performance instance types are included, excluded, or required.\n" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of CPU manufacturer names.\n" }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of excluded instance types.\n" }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "List of instance generation names.\n" }, "localStorage": { "type": "string", "description": "Indicates whether instance types with instance store volumes are included, excluded, or required.\n" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "List of local storage type names.\n" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "Price protection threshold for Spot Instances.\n" }, "memoryGibPerVcpus": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryGibPerVcpus:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryGibPerVcpus" }, "description": "List of objects describing the minimum and maximum amount of memory (GiB) per vCPU.\n" }, "memoryMibs": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryMib:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryMib" }, "description": "List of objects describing the minimum and maximum amount of memory (MiB).\n" }, "networkBandwidthGbps": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkBandwidthGbp:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkBandwidthGbp" }, "description": "List of objects describing the minimum and maximum amount of network bandwidth (Gbps).\n" }, "networkInterfaceCounts": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkInterfaceCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkInterfaceCount" }, "description": "List of objects describing the minimum and maximum amount of network interfaces.\n" }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "Price protection threshold for On-Demand Instances.\n" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicates whether instance types must support On-Demand Instance Hibernation.\n" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "Price protection threshold for Spot Instances.\n" }, "totalLocalStorageGbs": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementTotalLocalStorageGb:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementTotalLocalStorageGb" }, "description": "List of objects describing the minimum and maximum total storage (GB).\n" }, "vcpuCounts": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementVcpuCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementVcpuCount" }, "description": "List of objects describing the minimum and maximum number of vCPUs.\n" } }, "type": "object", "required": [ "acceleratorCounts", "acceleratorManufacturers", "acceleratorNames", "acceleratorTotalMemoryMibs", "acceleratorTypes", "allowedInstanceTypes", "bareMetal", "baselineEbsBandwidthMbps", "burstablePerformance", "cpuManufacturers", "excludedInstanceTypes", "instanceGenerations", "localStorage", "localStorageTypes", "maxSpotPriceAsPercentageOfOptimalOnDemandPrice", "memoryGibPerVcpus", "memoryMibs", "networkBandwidthGbps", "networkInterfaceCounts", "onDemandMaxPricePercentageOverLowestPrice", "requireHibernateSupport", "spotMaxPricePercentageOverLowestPrice", "totalLocalStorageGbs", "vcpuCounts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorTotalMemoryMib:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementBaselineEbsBandwidthMbp:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementBaselineEbsBandwidthMbp": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryGibPerVcpus:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryGibPerVcpus": { "properties": { "max": { "type": "number", "description": "Maximum.\n" }, "min": { "type": "number", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryMib:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkBandwidthGbp:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkBandwidthGbp": { "properties": { "max": { "type": "number", "description": "Maximum.\n" }, "min": { "type": "number", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkInterfaceCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementNetworkInterfaceCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementTotalLocalStorageGb:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementTotalLocalStorageGb": { "properties": { "max": { "type": "number", "description": "Maximum.\n" }, "min": { "type": "number", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementVcpuCount:getGroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirementVcpuCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification:getGroupMixedInstancesPolicyLaunchTemplateOverrideLaunchTemplateSpecification": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the launch template.\n" }, "launchTemplateName": { "type": "string", "description": "Name of the launch template.\n" }, "version": { "type": "string", "description": "Template version.\n" } }, "type": "object", "required": [ "launchTemplateId", "launchTemplateName", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupTag:getGroupTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "propagateAtLaunch": { "type": "boolean", "description": "Whether the tag is propagated to Amazon EC2 instances launched via this ASG.\n" }, "value": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "propagateAtLaunch", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupTrafficSource:getGroupTrafficSource": { "properties": { "identifier": { "type": "string", "description": "Identifies the traffic source. 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" }, "type": { "type": "string", "description": "Traffic source type.\n" } }, "type": "object", "required": [ "identifier", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupWarmPool:getGroupWarmPool": { "properties": { "instanceReusePolicies": { "type": "array", "items": { "$ref": "#/types/aws:autoscaling/getGroupWarmPoolInstanceReusePolicy:getGroupWarmPoolInstanceReusePolicy" }, "description": "List of instance reuse policy objects.\n" }, "maxGroupPreparedCapacity": { "type": "integer" }, "minSize": { "type": "integer", "description": "Minimum number of instances to maintain in the warm pool.\n" }, "poolState": { "type": "string", "description": "Instance state to transition to after the lifecycle actions are complete.\n" } }, "type": "object", "required": [ "instanceReusePolicies", "maxGroupPreparedCapacity", "minSize", "poolState" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscaling/getGroupWarmPoolInstanceReusePolicy:getGroupWarmPoolInstanceReusePolicy": { "properties": { "reuseOnScaleIn": { "type": "boolean", "description": "Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.\n" } }, "type": "object", "required": [ "reuseOnScaleIn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:autoscalingplans/ScalingPlanApplicationSource:ScalingPlanApplicationSource": { "properties": { "cloudformationStackArn": { "type": "string", "description": "ARN of a AWS CloudFormation stack.\n" }, "tagFilters": { "type": "array", "items": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanApplicationSourceTagFilter:ScalingPlanApplicationSourceTagFilter" }, "description": "Set of tags.\n" } }, "type": "object" }, "aws:autoscalingplans/ScalingPlanApplicationSourceTagFilter:ScalingPlanApplicationSourceTagFilter": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Tag values.\n" } }, "type": "object", "required": [ "key" ] }, "aws:autoscalingplans/ScalingPlanScalingInstruction:ScalingPlanScalingInstruction": { "properties": { "customizedLoadMetricSpecification": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanScalingInstructionCustomizedLoadMetricSpecification:ScalingPlanScalingInstructionCustomizedLoadMetricSpecification", "description": "Customized load metric to use for predictive scaling. You must specify either `customized_load_metric_specification` or `predefined_load_metric_specification` when configuring predictive scaling.\nMore details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_CustomizedLoadMetricSpecification.html).\n" }, "disableDynamicScaling": { "type": "boolean", "description": "Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to `false`.\n" }, "maxCapacity": { "type": "integer", "description": "Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for `predictive_scaling_max_capacity_behavior`.\n" }, "minCapacity": { "type": "integer", "description": "Minimum capacity of the resource.\n" }, "predefinedLoadMetricSpecification": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanScalingInstructionPredefinedLoadMetricSpecification:ScalingPlanScalingInstructionPredefinedLoadMetricSpecification", "description": "Predefined load metric to use for predictive scaling. You must specify either `predefined_load_metric_specification` or `customized_load_metric_specification` when configuring predictive scaling.\nMore details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_PredefinedLoadMetricSpecification.html).\n" }, "predictiveScalingMaxCapacityBehavior": { "type": "string", "description": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource.\nValid values: `SetForecastCapacityToMaxCapacity`, `SetMaxCapacityAboveForecastCapacity`, `SetMaxCapacityToForecastCapacity`.\n" }, "predictiveScalingMaxCapacityBuffer": { "type": "integer", "description": "Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.\n" }, "predictiveScalingMode": { "type": "string", "description": "Predictive scaling mode. Valid values: `ForecastAndScale`, `ForecastOnly`.\n" }, "resourceId": { "type": "string", "description": "ID of the resource. This string consists of the resource type and unique identifier.\n" }, "scalableDimension": { "type": "string", "description": "Scalable dimension associated with the resource. Valid values: `autoscaling:autoScalingGroup:DesiredCapacity`, `dynamodb:index:ReadCapacityUnits`, `dynamodb:index:WriteCapacityUnits`, `dynamodb:table:ReadCapacityUnits`, `dynamodb:table:WriteCapacityUnits`, `ecs:service:DesiredCount`, `ec2:spot-fleet-request:TargetCapacity`, `rds:cluster:ReadReplicaCount`.\n" }, "scalingPolicyUpdateBehavior": { "type": "string", "description": "Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: `KeepExternalPolicies`, `ReplaceExternalPolicies`. Defaults to `KeepExternalPolicies`.\n" }, "scheduledActionBufferTime": { "type": "integer", "description": "Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.\n" }, "serviceNamespace": { "type": "string", "description": "Namespace of the AWS service. Valid values: `autoscaling`, `dynamodb`, `ecs`, `ec2`, `rds`.\n" }, "targetTrackingConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfiguration:ScalingPlanScalingInstructionTargetTrackingConfiguration" }, "description": "Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.\nMore details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_TargetTrackingConfiguration.html).\n" } }, "type": "object", "required": [ "maxCapacity", "minCapacity", "resourceId", "scalableDimension", "serviceNamespace", "targetTrackingConfigurations" ], "language": { "nodejs": { "requiredOutputs": [ "maxCapacity", "minCapacity", "predictiveScalingMaxCapacityBuffer", "resourceId", "scalableDimension", "serviceNamespace", "targetTrackingConfigurations" ] } } }, "aws:autoscalingplans/ScalingPlanScalingInstructionCustomizedLoadMetricSpecification:ScalingPlanScalingInstructionCustomizedLoadMetricSpecification": { "properties": { "dimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" }, "statistic": { "type": "string", "description": "Statistic of the metric. Currently, the value must always be `Sum`.\n" }, "unit": { "type": "string", "description": "Unit of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace", "statistic" ] }, "aws:autoscalingplans/ScalingPlanScalingInstructionPredefinedLoadMetricSpecification:ScalingPlanScalingInstructionPredefinedLoadMetricSpecification": { "properties": { "predefinedLoadMetricType": { "type": "string", "description": "Metric type. Valid values: `ALBTargetGroupRequestCount`, `ASGTotalCPUUtilization`, `ASGTotalNetworkIn`, `ASGTotalNetworkOut`.\n" }, "resourceLabel": { "type": "string", "description": "Identifies the resource associated with the metric type.\n" } }, "type": "object", "required": [ "predefinedLoadMetricType" ] }, "aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfiguration:ScalingPlanScalingInstructionTargetTrackingConfiguration": { "properties": { "customizedScalingMetricSpecification": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification:ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification", "description": "Customized metric. You can specify either `customized_scaling_metric_specification` or `predefined_scaling_metric_specification`.\nMore details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_CustomizedScalingMetricSpecification.html).\n" }, "disableScaleIn": { "type": "boolean", "description": "Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to `false`.\n" }, "estimatedInstanceWarmup": { "type": "integer", "description": "Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.\nThis value is used only if the resource is an Auto Scaling group.\n" }, "predefinedScalingMetricSpecification": { "$ref": "#/types/aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification:ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification", "description": "Predefined metric. You can specify either `predefined_scaling_metric_specification` or `customized_scaling_metric_specification`.\nMore details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_PredefinedScalingMetricSpecification.html).\n" }, "scaleInCooldown": { "type": "integer", "description": "Amount of time, in seconds, after a scale in activity completes before another scale in activity can start.\nThis value is not used if the scalable resource is an Auto Scaling group.\n" }, "scaleOutCooldown": { "type": "integer", "description": "Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.\nThis value is not used if the scalable resource is an Auto Scaling group.\n" }, "targetValue": { "type": "number", "description": "Target value for the metric.\n" } }, "type": "object", "required": [ "targetValue" ] }, "aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification:ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification": { "properties": { "dimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Dimensions of the metric.\n" }, "metricName": { "type": "string", "description": "Name of the metric.\n" }, "namespace": { "type": "string", "description": "Namespace of the metric.\n" }, "statistic": { "type": "string", "description": "Statistic of the metric. Valid values: `Average`, `Maximum`, `Minimum`, `SampleCount`, `Sum`.\n" }, "unit": { "type": "string", "description": "Unit of the metric.\n" } }, "type": "object", "required": [ "metricName", "namespace", "statistic" ] }, "aws:autoscalingplans/ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification:ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification": { "properties": { "predefinedScalingMetricType": { "type": "string", "description": "Metric type. Valid values: `ALBRequestCountPerTarget`, `ASGAverageCPUUtilization`, `ASGAverageNetworkIn`, `ASGAverageNetworkOut`, `DynamoDBReadCapacityUtilization`, `DynamoDBWriteCapacityUtilization`, `ECSServiceAverageCPUUtilization`, `ECSServiceAverageMemoryUtilization`, `EC2SpotFleetRequestAverageCPUUtilization`, `EC2SpotFleetRequestAverageNetworkIn`, `EC2SpotFleetRequestAverageNetworkOut`, `RDSReaderAverageCPUUtilization`, `RDSReaderAverageDatabaseConnections`.\n" }, "resourceLabel": { "type": "string", "description": "Identifies the resource associated with the metric type.\n" } }, "type": "object", "required": [ "predefinedScalingMetricType" ] }, "aws:backup/FrameworkControl:FrameworkControl": { "properties": { "inputParameters": { "type": "array", "items": { "$ref": "#/types/aws:backup/FrameworkControlInputParameter:FrameworkControlInputParameter" }, "description": "One or more input parameter blocks. An example of a control with two parameters is: \"backup plan frequency is at least daily and the retention period is at least 1 year\". The first parameter is daily. The second parameter is 1 year. Detailed below.\n" }, "name": { "type": "string", "description": "The name of a control. This name is between 1 and 256 characters.\n" }, "scope": { "$ref": "#/types/aws:backup/FrameworkControlScope:FrameworkControlScope", "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. Detailed below.\n" } }, "type": "object", "required": [ "name" ] }, "aws:backup/FrameworkControlInputParameter:FrameworkControlInputParameter": { "properties": { "name": { "type": "string", "description": "The name of a parameter, for example, BackupPlanFrequency.\n" }, "value": { "type": "string", "description": "The value of parameter, for example, hourly.\n" } }, "type": "object" }, "aws:backup/FrameworkControlScope:FrameworkControlScope": { "properties": { "complianceResourceIds": { "type": "array", "items": { "type": "string" }, "description": "The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.\n" }, "complianceResourceTypes": { "type": "array", "items": { "type": "string" }, "description": "Describes whether the control scope includes one or more types of resources, such as EFS or RDS.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "complianceResourceIds", "complianceResourceTypes" ] } } }, "aws:backup/LogicallyAirGappedVaultTimeouts:LogicallyAirGappedVaultTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:backup/PlanAdvancedBackupSetting:PlanAdvancedBackupSetting": { "properties": { "backupOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs. Set to `{ WindowsVSS = \"enabled\" }` to enable Windows VSS backup option and create a VSS Windows backup.\n" }, "resourceType": { "type": "string", "description": "The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2. Valid values: `EC2`.\n" } }, "type": "object", "required": [ "backupOptions", "resourceType" ] }, "aws:backup/PlanRule:PlanRule": { "properties": { "completionWindow": { "type": "integer", "description": "The amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.\n" }, "copyActions": { "type": "array", "items": { "$ref": "#/types/aws:backup/PlanRuleCopyAction:PlanRuleCopyAction" }, "description": "Configuration block(s) with copy operation settings. Detailed below.\n" }, "enableContinuousBackup": { "type": "boolean", "description": "Enable continuous backups for supported resources.\n" }, "lifecycle": { "$ref": "#/types/aws:backup/PlanRuleLifecycle:PlanRuleLifecycle", "description": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Fields documented below.\n" }, "recoveryPointTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata that you can assign to help organize the resources that you create.\n" }, "ruleName": { "type": "string", "description": "An display name for a backup rule.\n" }, "schedule": { "type": "string", "description": "A CRON expression specifying when AWS Backup initiates a backup job.\n" }, "scheduleExpressionTimezone": { "type": "string", "description": "The timezone in which the schedule expression is set. Default value: `\"Etc/UTC\"`.\n" }, "startWindow": { "type": "integer", "description": "The amount of time in minutes before beginning a backup.\n" }, "targetVaultName": { "type": "string", "description": "The name of a logical container where backups are stored.\n" } }, "type": "object", "required": [ "ruleName", "targetVaultName" ] }, "aws:backup/PlanRuleCopyAction:PlanRuleCopyAction": { "properties": { "destinationVaultArn": { "type": "string", "description": "An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.\n" }, "lifecycle": { "$ref": "#/types/aws:backup/PlanRuleCopyActionLifecycle:PlanRuleCopyActionLifecycle", "description": "The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above.\n" } }, "type": "object", "required": [ "destinationVaultArn" ] }, "aws:backup/PlanRuleCopyActionLifecycle:PlanRuleCopyActionLifecycle": { "properties": { "coldStorageAfter": { "type": "integer", "description": "Specifies the number of days after creation that a recovery point is moved to cold storage.\n" }, "deleteAfter": { "type": "integer", "description": "Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `cold_storage_after`.\n" }, "optInToArchiveForSupportedResources": { "type": "boolean", "description": "This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "optInToArchiveForSupportedResources" ] } } }, "aws:backup/PlanRuleLifecycle:PlanRuleLifecycle": { "properties": { "coldStorageAfter": { "type": "integer", "description": "Specifies the number of days after creation that a recovery point is moved to cold storage.\n" }, "deleteAfter": { "type": "integer", "description": "Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `cold_storage_after`.\n" }, "optInToArchiveForSupportedResources": { "type": "boolean", "description": "This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "optInToArchiveForSupportedResources" ] } } }, "aws:backup/ReportPlanReportDeliveryChannel:ReportPlanReportDeliveryChannel": { "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.\n" }, "s3BucketName": { "type": "string", "description": "The unique name of the S3 bucket that receives your reports.\n" }, "s3KeyPrefix": { "type": "string", "description": "The prefix for where 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.\n" } }, "type": "object", "required": [ "s3BucketName" ] }, "aws:backup/ReportPlanReportSetting:ReportPlanReportSetting": { "properties": { "accounts": { "type": "array", "items": { "type": "string" }, "description": "Specifies the list of accounts a report covers.\n" }, "frameworkArns": { "type": "array", "items": { "type": "string" }, "description": "Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.\n" }, "numberOfFrameworks": { "type": "integer", "description": "Specifies the number of frameworks a report covers.\n" }, "organizationUnits": { "type": "array", "items": { "type": "string" }, "description": "Specifies the list of Organizational Units a report covers.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Specifies the list of regions a report covers.\n" }, "reportTemplate": { "type": "string", "description": "Identifies the report template for the report. Reports are built using a report template. The report templates are: `RESOURCE_COMPLIANCE_REPORT` | `CONTROL_COMPLIANCE_REPORT` | `BACKUP_JOB_REPORT` | `COPY_JOB_REPORT` | `RESTORE_JOB_REPORT`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "reportTemplate" ] }, "aws:backup/RestoreTestingPlanRecoveryPointSelection:RestoreTestingPlanRecoveryPointSelection": { "properties": { "algorithm": { "type": "string", "description": "Specifies the algorithm used for selecting recovery points. Valid values are \"RANDOM_WITHIN_WINDOW\" and \"LATEST_WITHIN_WINDOW\".\n" }, "excludeVaults": { "type": "array", "items": { "type": "string" }, "description": "Specifies the backup vaults to exclude from the recovery point selection. Each value must be a valid AWS ARN for a backup vault or \"*\" to exclude all backup vaults.\n" }, "includeVaults": { "type": "array", "items": { "type": "string" }, "description": "Specifies the backup vaults to include in the recovery point selection. Each value must be a valid AWS ARN for a backup vault or \"*\" to include all backup vaults.\n" }, "recoveryPointTypes": { "type": "array", "items": { "type": "string" }, "description": "Specifies the types of recovery points to include in the selection. Valid values are \"CONTINUOUS\" and \"SNAPSHOT\".\n" }, "selectionWindowDays": { "type": "integer", "description": "Specifies the number of days within which the recovery points should be selected. Must be a value between 1 and 365.\n" } }, "type": "object", "required": [ "algorithm", "includeVaults", "recoveryPointTypes" ], "language": { "nodejs": { "requiredOutputs": [ "algorithm", "excludeVaults", "includeVaults", "recoveryPointTypes", "selectionWindowDays" ] } } }, "aws:backup/RestoreTestingSelectionProtectedResourceConditions:RestoreTestingSelectionProtectedResourceConditions": { "properties": { "stringEquals": { "type": "array", "items": { "$ref": "#/types/aws:backup/RestoreTestingSelectionProtectedResourceConditionsStringEqual:RestoreTestingSelectionProtectedResourceConditionsStringEqual" }, "description": "The list of string equals conditions for resource tags. Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\". See the structure for details\n" }, "stringNotEquals": { "type": "array", "items": { "$ref": "#/types/aws:backup/RestoreTestingSelectionProtectedResourceConditionsStringNotEqual:RestoreTestingSelectionProtectedResourceConditionsStringNotEqual" }, "description": "The list of string not equals conditions for resource tags. 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.\". See the structure for details\n" } }, "type": "object" }, "aws:backup/RestoreTestingSelectionProtectedResourceConditionsStringEqual:RestoreTestingSelectionProtectedResourceConditionsStringEqual": { "properties": { "key": { "type": "string", "description": "The Tag name, must start with one of the following prefixes: [aws:ResourceTag/] with a Minimum length of 1. Maximum length of 128, and can contain characters that are letters, white space, and numbers that can be represented in UTF-8 and the following characters: `+ - = . _ : /`.\n" }, "value": { "type": "string", "description": "The value of the Tag. Maximum length of 256.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/RestoreTestingSelectionProtectedResourceConditionsStringNotEqual:RestoreTestingSelectionProtectedResourceConditionsStringNotEqual": { "properties": { "key": { "type": "string", "description": "The Tag name, must start with one of the following prefixes: [aws:ResourceTag/] with a Minimum length of 1. Maximum length of 128, and can contain characters that are letters, white space, and numbers that can be represented in UTF-8 and the following characters: `+ - = . _ : /`.\n" }, "value": { "type": "string", "description": "The value of the Tag. Maximum length of 256.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/SelectionCondition:SelectionCondition": { "properties": { "stringEquals": { "type": "array", "items": { "$ref": "#/types/aws:backup/SelectionConditionStringEqual:SelectionConditionStringEqual" }, "description": "Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching\". See below for details.\n", "willReplaceOnChanges": true }, "stringLikes": { "type": "array", "items": { "$ref": "#/types/aws:backup/SelectionConditionStringLike:SelectionConditionStringLike" }, "description": "Filters the values of your tagged resources for matching tag values with the use of a wildcard character (`*`) anywhere in the string. For example, `prod*` or `*rod*` matches the tag value `production`. See below for details.\n", "willReplaceOnChanges": true }, "stringNotEquals": { "type": "array", "items": { "$ref": "#/types/aws:backup/SelectionConditionStringNotEqual:SelectionConditionStringNotEqual" }, "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\". See below for details.\n", "willReplaceOnChanges": true }, "stringNotLikes": { "type": "array", "items": { "$ref": "#/types/aws:backup/SelectionConditionStringNotLike:SelectionConditionStringNotLike" }, "description": "Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (`*`) anywhere in the string. See below for details.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:backup/SelectionConditionStringEqual:SelectionConditionStringEqual": { "properties": { "key": { "type": "string", "description": "Key for the filter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value for the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/SelectionConditionStringLike:SelectionConditionStringLike": { "properties": { "key": { "type": "string", "description": "Key for the filter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value for the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/SelectionConditionStringNotEqual:SelectionConditionStringNotEqual": { "properties": { "key": { "type": "string", "description": "Key for the filter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value for the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/SelectionConditionStringNotLike:SelectionConditionStringNotLike": { "properties": { "key": { "type": "string", "description": "Key for the filter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value for the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "value" ] }, "aws:backup/SelectionSelectionTag:SelectionSelectionTag": { "properties": { "key": { "type": "string", "description": "Key for the filter.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "An operation, such as `STRINGEQUALS`, that is applied to the key-value pair used to filter resources in a selection.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value for the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "type", "value" ] }, "aws:backup/getFrameworkControl:getFrameworkControl": { "properties": { "inputParameters": { "type": "array", "items": { "$ref": "#/types/aws:backup/getFrameworkControlInputParameter:getFrameworkControlInputParameter" }, "description": "One or more input parameter blocks. An example of a control with two parameters is: \"backup plan frequency is at least daily and the retention period is at least 1 year\". The first parameter is daily. The second parameter is 1 year. Detailed below.\n" }, "name": { "type": "string", "description": "Backup framework name.\n" }, "scopes": { "type": "array", "items": { "$ref": "#/types/aws:backup/getFrameworkControlScope:getFrameworkControlScope" }, "description": "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. Detailed below.\n" } }, "type": "object", "required": [ "inputParameters", "name", "scopes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getFrameworkControlInputParameter:getFrameworkControlInputParameter": { "properties": { "name": { "type": "string", "description": "Backup framework name.\n" }, "value": { "type": "string", "description": "Value of parameter, for example, hourly.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getFrameworkControlScope:getFrameworkControlScope": { "properties": { "complianceResourceIds": { "type": "array", "items": { "type": "string" }, "description": "The ID of the only AWS resource that you want your control scope to contain.\n" }, "complianceResourceTypes": { "type": "array", "items": { "type": "string" }, "description": "Describes whether the control scope includes one or more types of resources, such as EFS or RDS.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided.\n" } }, "type": "object", "required": [ "complianceResourceIds", "complianceResourceTypes", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getPlanRule:getPlanRule": { "properties": { "completionWindow": { "type": "integer" }, "copyActions": { "type": "array", "items": { "$ref": "#/types/aws:backup/getPlanRuleCopyAction:getPlanRuleCopyAction" } }, "enableContinuousBackup": { "type": "boolean" }, "lifecycles": { "type": "array", "items": { "$ref": "#/types/aws:backup/getPlanRuleLifecycle:getPlanRuleLifecycle" } }, "recoveryPointTags": { "type": "object", "additionalProperties": { "type": "string" } }, "ruleName": { "type": "string" }, "schedule": { "type": "string" }, "scheduleExpressionTimezone": { "type": "string" }, "startWindow": { "type": "integer" }, "targetVaultName": { "type": "string" } }, "type": "object", "required": [ "completionWindow", "copyActions", "enableContinuousBackup", "lifecycles", "ruleName", "schedule", "scheduleExpressionTimezone", "startWindow", "targetVaultName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getPlanRuleCopyAction:getPlanRuleCopyAction": { "properties": { "destinationVaultArn": { "type": "string" }, "lifecycles": { "type": "array", "items": { "$ref": "#/types/aws:backup/getPlanRuleCopyActionLifecycle:getPlanRuleCopyActionLifecycle" } } }, "type": "object", "required": [ "destinationVaultArn", "lifecycles" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getPlanRuleCopyActionLifecycle:getPlanRuleCopyActionLifecycle": { "properties": { "coldStorageAfter": { "type": "integer" }, "deleteAfter": { "type": "integer" }, "optInToArchiveForSupportedResources": { "type": "boolean" } }, "type": "object", "required": [ "coldStorageAfter", "deleteAfter", "optInToArchiveForSupportedResources" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getPlanRuleLifecycle:getPlanRuleLifecycle": { "properties": { "coldStorageAfter": { "type": "integer" }, "deleteAfter": { "type": "integer" }, "optInToArchiveForSupportedResources": { "type": "boolean" } }, "type": "object", "required": [ "coldStorageAfter", "deleteAfter", "optInToArchiveForSupportedResources" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getReportPlanReportDeliveryChannel:getReportPlanReportDeliveryChannel": { "properties": { "formats": { "type": "array", "items": { "type": "string" }, "description": "List of the format of your reports: CSV, JSON, or both.\n" }, "s3BucketName": { "type": "string", "description": "Unique name of the S3 bucket that receives your reports.\n" }, "s3KeyPrefix": { "type": "string", "description": "Prefix for where 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.\n" } }, "type": "object", "required": [ "formats", "s3BucketName", "s3KeyPrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:backup/getReportPlanReportSetting:getReportPlanReportSetting": { "properties": { "accounts": { "type": "array", "items": { "type": "string" }, "description": "(Optional) Specifies the list of accounts a report covers.\n" }, "frameworkArns": { "type": "array", "items": { "type": "string" }, "description": "ARNs of the frameworks a report covers.\n" }, "numberOfFrameworks": { "type": "integer", "description": "Specifies the number of frameworks a report covers.\n" }, "organizationUnits": { "type": "array", "items": { "type": "string" }, "description": "(Optional) Specifies the list of Organizational Units a report covers.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "(Optional) Specifies the list of regions a report covers.\n" }, "reportTemplate": { "type": "string", "description": "Identifies the report template for the report. Reports are built using a report template.\n" } }, "type": "object", "required": [ "accounts", "frameworkArns", "numberOfFrameworks", "organizationUnits", "regions", "reportTemplate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/ComputeEnvironmentComputeResources:ComputeEnvironmentComputeResources": { "properties": { "allocationStrategy": { "type": "string", "description": "The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-allocationStrategy). Defaults to `BEST_FIT`. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "bidPercentage": { "type": "integer", "description": "Integer of 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 bid percentage is 20% (`20`), then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. If you leave this field empty, the default value is 100% of the On-Demand price. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "desiredVcpus": { "type": "integer", "description": "The desired number of EC2 vCPUS in the compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "ec2Configurations": { "type": "array", "items": { "$ref": "#/types/aws:batch/ComputeEnvironmentComputeResourcesEc2Configuration:ComputeEnvironmentComputeResourcesEc2Configuration" }, "description": "Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2. This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.\n", "willReplaceOnChanges": true }, "ec2KeyPair": { "type": "string", "description": "The EC2 key pair that is used for instances launched in the compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "imageId": { "type": "string", "description": "The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified. (Deprecated, use `ec2_configuration` `image_id_override` instead)\n" }, "instanceRole": { "type": "string", "description": "The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of instance types that may be launched. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "launchTemplate": { "$ref": "#/types/aws:batch/ComputeEnvironmentComputeResourcesLaunchTemplate:ComputeEnvironmentComputeResourcesLaunchTemplate", "description": "The launch template to use for your compute resources. See details below. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n", "willReplaceOnChanges": true }, "maxVcpus": { "type": "integer", "description": "The maximum number of EC2 vCPUs that an environment can reach.\n" }, "minVcpus": { "type": "integer", "description": "The minimum number of EC2 vCPUs that an environment should maintain. For `EC2` or `SPOT` compute environments, if the parameter is not explicitly defined, a `0` default value will be set. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "placementGroup": { "type": "string", "description": "The Amazon EC2 placement group to associate with your compute resources.\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of EC2 security group that are associated with instances launched in the compute environment. This parameter is required for Fargate compute environments.\n" }, "spotIamFleetRole": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This parameter is required for SPOT compute environments. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n", "willReplaceOnChanges": true }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "A list of VPC subnets into which the compute resources are launched.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair tags to be applied to resources that are launched in the compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.\n" }, "type": { "type": "string", "description": "The type of compute environment. Valid items are `EC2`, `SPOT`, `FARGATE` or `FARGATE_SPOT`.\n" } }, "type": "object", "required": [ "maxVcpus", "subnets", "type" ], "language": { "nodejs": { "requiredOutputs": [ "desiredVcpus", "ec2Configurations", "maxVcpus", "subnets", "type" ] } } }, "aws:batch/ComputeEnvironmentComputeResourcesEc2Configuration:ComputeEnvironmentComputeResourcesEc2Configuration": { "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 `image_id` argument in the `compute_resources` block.\n" }, "imageType": { "type": "string", "description": "The image type to match with the instance type to select an AMI. If the `image_id_override` 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.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "imageIdOverride" ] } } }, "aws:batch/ComputeEnvironmentComputeResourcesLaunchTemplate:ComputeEnvironmentComputeResourcesLaunchTemplate": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the launch template. You must specify either the launch template ID or launch template name in the request, but not both.\n" }, "launchTemplateName": { "type": "string", "description": "Name of the launch template.\n" }, "version": { "type": "string", "description": "The version number of the launch template. Default: The default version of the launch template.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "version" ] } } }, "aws:batch/ComputeEnvironmentEksConfiguration:ComputeEnvironmentEksConfiguration": { "properties": { "eksClusterArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon EKS cluster.\n", "willReplaceOnChanges": true }, "kubernetesNamespace": { "type": "string", "description": "The namespace of the Amazon EKS cluster. AWS Batch manages pods in this namespace.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "eksClusterArn", "kubernetesNamespace" ] }, "aws:batch/ComputeEnvironmentUpdatePolicy:ComputeEnvironmentUpdatePolicy": { "properties": { "jobExecutionTimeoutMinutes": { "type": "integer", "description": "Specifies the job timeout (in minutes) when the compute environment infrastructure is updated.\n" }, "terminateJobsOnUpdate": { "type": "boolean", "description": "Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated.\n" } }, "type": "object", "required": [ "jobExecutionTimeoutMinutes", "terminateJobsOnUpdate" ] }, "aws:batch/JobDefinitionEksProperties:JobDefinitionEksProperties": { "properties": { "podProperties": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodProperties:JobDefinitionEksPropertiesPodProperties", "description": "Properties for the Kubernetes pod resources of a job. See `pod_properties` below.\n" } }, "type": "object", "required": [ "podProperties" ] }, "aws:batch/JobDefinitionEksPropertiesPodProperties:JobDefinitionEksPropertiesPodProperties": { "properties": { "containers": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesContainers:JobDefinitionEksPropertiesPodPropertiesContainers", "description": "Properties of the container that's used on the Amazon EKS pod. See containers below.\n" }, "dnsPolicy": { "type": "string", "description": "DNS policy for the pod. The default value is `ClusterFirst`. If the `host_network` argument 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 in the Kubernetes documentation.\n" }, "hostNetwork": { "type": "boolean", "description": "Whether 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.\n" }, "imagePullSecrets": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesImagePullSecret:JobDefinitionEksPropertiesPodPropertiesImagePullSecret" }, "description": "List of Kubernetes secret resources. See `image_pull_secret` below.\n" }, "initContainers": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainer:JobDefinitionEksPropertiesPodPropertiesInitContainer" }, "description": "Containers which 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. See containers below.\n" }, "metadata": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesMetadata:JobDefinitionEksPropertiesPodPropertiesMetadata", "description": "Metadata about the Kubernetes pod.\n" }, "serviceAccountName": { "type": "string", "description": "Name of the service account that's used to run the pod.\n" }, "shareProcessNamespace": { "type": "boolean", "description": "Indicates if the processes in a container are shared, or visible, to other containers in the same pod.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesVolume:JobDefinitionEksPropertiesPodPropertiesVolume" }, "description": "Volumes for a job definition that uses Amazon EKS resources. AWS Batch supports emptyDir, hostPath, and secret volume types.\n" } }, "type": "object", "required": [ "containers" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesContainers:JobDefinitionEksPropertiesPodPropertiesContainers": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "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 portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "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" }, "envs": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersEnv:JobDefinitionEksPropertiesPodPropertiesContainersEnv" }, "description": "Environment variables to pass to a container. See EKS Environment below.\n" }, "image": { "type": "string", "description": "Docker image used to start the container.\n" }, "imagePullPolicy": { "type": "string", "description": "Image pull policy for the container. Supported values are `Always`, `IfNotPresent`, and `Never`.\n" }, "name": { "type": "string", "description": "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.\n" }, "resources": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersResources:JobDefinitionEksPropertiesPodPropertiesContainersResources", "description": "Type and amount of resources to assign to a container. The supported resources include `memory`, `cpu`, and `nvidia.com/gpu`.\n" }, "securityContext": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersSecurityContext:JobDefinitionEksPropertiesPodPropertiesContainersSecurityContext", "description": "Security context for a job.\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersVolumeMount:JobDefinitionEksPropertiesPodPropertiesContainersVolumeMount" }, "description": "Volume mounts for the container.\n" } }, "type": "object", "required": [ "image" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersEnv:JobDefinitionEksPropertiesPodPropertiesContainersEnv": { "properties": { "name": { "type": "string", "description": "Name of the job definition.\n" }, "value": { "type": "string", "description": "Value of the environment variable.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersResources:JobDefinitionEksPropertiesPodPropertiesContainersResources": { "properties": { "limits": { "type": "object", "additionalProperties": { "type": "string" } }, "requests": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersSecurityContext:JobDefinitionEksPropertiesPodPropertiesContainersSecurityContext": { "properties": { "privileged": { "type": "boolean" }, "readOnlyRootFileSystem": { "type": "boolean" }, "runAsGroup": { "type": "integer" }, "runAsNonRoot": { "type": "boolean" }, "runAsUser": { "type": "integer" } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesContainersVolumeMount:JobDefinitionEksPropertiesPodPropertiesContainersVolumeMount": { "properties": { "mountPath": { "type": "string" }, "name": { "type": "string", "description": "Name of the job definition.\n" }, "readOnly": { "type": "boolean" } }, "type": "object", "required": [ "mountPath", "name" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesImagePullSecret:JobDefinitionEksPropertiesPodPropertiesImagePullSecret": { "properties": { "name": { "type": "string", "description": "Unique identifier.\n" } }, "type": "object", "required": [ "name" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainer:JobDefinitionEksPropertiesPodPropertiesInitContainer": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "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 portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "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" }, "envs": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerEnv:JobDefinitionEksPropertiesPodPropertiesInitContainerEnv" }, "description": "Environment variables to pass to a container. See EKS Environment below.\n" }, "image": { "type": "string", "description": "Docker image used to start the container.\n" }, "imagePullPolicy": { "type": "string", "description": "Image pull policy for the container. Supported values are `Always`, `IfNotPresent`, and `Never`.\n" }, "name": { "type": "string", "description": "Name of the job definition.\n" }, "resources": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerResources:JobDefinitionEksPropertiesPodPropertiesInitContainerResources", "description": "Type and amount of resources to assign to a container. The supported resources include `memory`, `cpu`, and `nvidia.com/gpu`.\n" }, "securityContext": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerSecurityContext:JobDefinitionEksPropertiesPodPropertiesInitContainerSecurityContext", "description": "Security context for a job.\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerVolumeMount:JobDefinitionEksPropertiesPodPropertiesInitContainerVolumeMount" }, "description": "Volume mounts for the container.\n" } }, "type": "object", "required": [ "image" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerEnv:JobDefinitionEksPropertiesPodPropertiesInitContainerEnv": { "properties": { "name": { "type": "string", "description": "Name of the job definition.\n" }, "value": { "type": "string", "description": "Value of the environment variable.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerResources:JobDefinitionEksPropertiesPodPropertiesInitContainerResources": { "properties": { "limits": { "type": "object", "additionalProperties": { "type": "string" } }, "requests": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerSecurityContext:JobDefinitionEksPropertiesPodPropertiesInitContainerSecurityContext": { "properties": { "privileged": { "type": "boolean" }, "readOnlyRootFileSystem": { "type": "boolean" }, "runAsGroup": { "type": "integer" }, "runAsNonRoot": { "type": "boolean" }, "runAsUser": { "type": "integer" } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesInitContainerVolumeMount:JobDefinitionEksPropertiesPodPropertiesInitContainerVolumeMount": { "properties": { "mountPath": { "type": "string" }, "name": { "type": "string", "description": "Name of the job definition.\n" }, "readOnly": { "type": "boolean" } }, "type": "object", "required": [ "mountPath", "name" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesMetadata:JobDefinitionEksPropertiesPodPropertiesMetadata": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pairs used to identify, sort, and organize cube resources.\n" } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesVolume:JobDefinitionEksPropertiesPodPropertiesVolume": { "properties": { "emptyDir": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeEmptyDir:JobDefinitionEksPropertiesPodPropertiesVolumeEmptyDir" }, "hostPath": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeHostPath:JobDefinitionEksPropertiesPodPropertiesVolumeHostPath" }, "name": { "type": "string", "description": "Name of the job definition.\n" }, "secret": { "$ref": "#/types/aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeSecret:JobDefinitionEksPropertiesPodPropertiesVolumeSecret" } }, "type": "object" }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeEmptyDir:JobDefinitionEksPropertiesPodPropertiesVolumeEmptyDir": { "properties": { "medium": { "type": "string", "description": "Medium to store the volume. The default value is an empty string, which uses the storage of the node.\n" }, "sizeLimit": { "type": "string", "description": "Maximum size of the volume. By default, there's no maximum size defined.\n" } }, "type": "object", "required": [ "sizeLimit" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeHostPath:JobDefinitionEksPropertiesPodPropertiesVolumeHostPath": { "properties": { "path": { "type": "string", "description": "Path of the file or directory on the host to mount into containers on the pod.\n" } }, "type": "object", "required": [ "path" ] }, "aws:batch/JobDefinitionEksPropertiesPodPropertiesVolumeSecret:JobDefinitionEksPropertiesPodPropertiesVolumeSecret": { "properties": { "optional": { "type": "boolean", "description": "Whether the secret or the secret's keys must be defined.\n" }, "secretName": { "type": "string", "description": "Name of the secret. The name must be allowed as a DNS subdomain name.\n" } }, "type": "object", "required": [ "secretName" ] }, "aws:batch/JobDefinitionRetryStrategy:JobDefinitionRetryStrategy": { "properties": { "attempts": { "type": "integer", "description": "Number of times to move a job to the `RUNNABLE` status. You may specify between `1` and `10` attempts.\n" }, "evaluateOnExits": { "type": "array", "items": { "$ref": "#/types/aws:batch/JobDefinitionRetryStrategyEvaluateOnExit:JobDefinitionRetryStrategyEvaluateOnExit" }, "description": "Evaluate on exit conditions under which the job should be retried or failed. If this parameter is specified, then the `attempts` parameter must also be specified. You may specify up to 5 configuration blocks.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:batch/JobDefinitionRetryStrategyEvaluateOnExit:JobDefinitionRetryStrategyEvaluateOnExit": { "properties": { "action": { "type": "string", "description": "Action to take if all of the specified conditions are met. The values are not case sensitive. Valid values: `retry`, `exit`.\n" }, "onExitCode": { "type": "string", "description": "Glob pattern to match against the decimal representation of the exit code returned for a job.\n" }, "onReason": { "type": "string", "description": "Glob pattern to match against the reason returned for a job.\n" }, "onStatusReason": { "type": "string", "description": "Glob pattern to match against the status reason returned for a job.\n" } }, "type": "object", "required": [ "action" ] }, "aws:batch/JobDefinitionTimeout:JobDefinitionTimeout": { "properties": { "attemptDurationSeconds": { "type": "integer", "description": "Time duration in seconds after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is `60` seconds.\n" } }, "type": "object" }, "aws:batch/JobQueueComputeEnvironmentOrder:JobQueueComputeEnvironmentOrder": { "properties": { "computeEnvironment": { "type": "string", "description": "The Amazon Resource Name (ARN) of the compute environment.\n" }, "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.\n" } }, "type": "object", "required": [ "computeEnvironment", "order" ] }, "aws:batch/JobQueueJobStateTimeLimitAction:JobQueueJobStateTimeLimitAction": { "properties": { "action": { "type": "string", "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. Valid values include `\"CANCEL\"`\n" }, "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. Valid values include integers between `600` \u0026 `86400`\n" }, "reason": { "type": "string", "description": "The reason to log for the action being taken.\n" }, "state": { "type": "string", "description": "The state of the job needed to trigger the action. Valid values include `\"RUNNABLE\"`.\n" } }, "type": "object", "required": [ "action", "maxTimeSeconds", "reason", "state" ] }, "aws:batch/JobQueueTimeouts:JobQueueTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:batch/SchedulingPolicyFairSharePolicy:SchedulingPolicyFairSharePolicy": { "properties": { "computeReservation": { "type": "integer", "description": "A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used. For more information, see [FairsharePolicy](https://docs.aws.amazon.com/batch/latest/APIReference/API_FairsharePolicy.html).\n" }, "shareDecaySeconds": { "type": "integer" }, "shareDistributions": { "type": "array", "items": { "$ref": "#/types/aws:batch/SchedulingPolicyFairSharePolicyShareDistribution:SchedulingPolicyFairSharePolicyShareDistribution" }, "description": "One or more share distribution blocks which define the weights for the fair share identifiers for the fair share policy. For more information, see [FairsharePolicy](https://docs.aws.amazon.com/batch/latest/APIReference/API_FairsharePolicy.html). The `share_distribution` block is documented below.\n" } }, "type": "object" }, "aws:batch/SchedulingPolicyFairSharePolicyShareDistribution:SchedulingPolicyFairSharePolicyShareDistribution": { "properties": { "shareIdentifier": { "type": "string", "description": "A fair share identifier or fair share identifier prefix. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html).\n" }, "weightFactor": { "type": "number", "description": "The weight factor for the fair share identifier. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html).\n" } }, "type": "object", "required": [ "shareIdentifier" ] }, "aws:batch/getComputeEnvironmentUpdatePolicy:getComputeEnvironmentUpdatePolicy": { "properties": { "jobExecutionTimeoutMinutes": { "type": "integer" }, "terminateJobsOnUpdate": { "type": "boolean" } }, "type": "object", "required": [ "jobExecutionTimeoutMinutes", "terminateJobsOnUpdate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksProperty:getJobDefinitionEksProperty": { "properties": { "podProperties": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodProperty:getJobDefinitionEksPropertyPodProperty" }, "description": "The properties for the Kubernetes pod resources of a job.\n" } }, "type": "object", "required": [ "podProperties" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodProperty:getJobDefinitionEksPropertyPodProperty": { "properties": { "containers": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyContainer:getJobDefinitionEksPropertyPodPropertyContainer" }, "description": "The properties of the container that's used on the Amazon EKS pod. See containers below.\n" }, "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.\n" }, "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.\n" }, "imagePullSecrets": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyImagePullSecret:getJobDefinitionEksPropertyPodPropertyImagePullSecret" } }, "initContainers": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainer:getJobDefinitionEksPropertyPodPropertyInitContainer" }, "description": "Containers which 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. See containers below.\n" }, "metadatas": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyMetadata:getJobDefinitionEksPropertyPodPropertyMetadata" }, "description": "Metadata about the Kubernetes pod.\n" }, "serviceAccountName": { "type": "string", "description": "The name of the service account that's used to run the pod.\n" }, "shareProcessNamespace": { "type": "boolean", "description": "(Optional) Indicates if the processes in a container are shared, or visible, to other containers in the same pod.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyVolume:getJobDefinitionEksPropertyPodPropertyVolume" }, "description": "A list of data volumes used in a job.\n" } }, "type": "object", "required": [ "containers", "dnsPolicy", "hostNetwork", "imagePullSecrets", "initContainers", "metadatas", "serviceAccountName", "shareProcessNamespace", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyContainer:getJobDefinitionEksPropertyPodPropertyContainer": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "An array of arguments to the entrypoint\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "The command that's passed to the container.\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyContainerEnv:getJobDefinitionEksPropertyPodPropertyContainerEnv" }, "description": "The environment variables to pass to a container. Array of EksContainerEnvironmentVariable objects.\n" }, "image": { "type": "string", "description": "The image used to start a container.\n" }, "imagePullPolicy": { "type": "string", "description": "The image pull policy for the container.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyContainerResource:getJobDefinitionEksPropertyPodPropertyContainerResource" }, "description": "The type and amount of resources to assign to a container.\n" }, "securityContexts": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyContainerSecurityContext:getJobDefinitionEksPropertyPodPropertyContainerSecurityContext" }, "description": "The security context for a job.\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyContainerVolumeMount:getJobDefinitionEksPropertyPodPropertyContainerVolumeMount" }, "description": "The volume mounts for the container.\n" } }, "type": "object", "required": [ "args", "commands", "envs", "image", "imagePullPolicy", "name", "resources", "securityContexts", "volumeMounts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyContainerEnv:getJobDefinitionEksPropertyPodPropertyContainerEnv": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "value": { "type": "string", "description": "The quantity of the specified resource to reserve for the container.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyContainerResource:getJobDefinitionEksPropertyPodPropertyContainerResource": { "properties": { "limits": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The type and quantity of the resources to reserve for the container.\n" }, "requests": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The type and quantity of the resources to request for the container.\n" } }, "type": "object", "required": [ "limits", "requests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyContainerSecurityContext:getJobDefinitionEksPropertyPodPropertyContainerSecurityContext": { "properties": { "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).\n" }, "readOnlyRootFileSystem": { "type": "boolean" }, "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.\n" }, "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.\n" }, "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.\n" } }, "type": "object", "required": [ "privileged", "readOnlyRootFileSystem", "runAsGroup", "runAsNonRoot", "runAsUser" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyContainerVolumeMount:getJobDefinitionEksPropertyPodPropertyContainerVolumeMount": { "properties": { "mountPath": { "type": "string", "description": "The path on the container where the volume is mounted.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "readOnly": { "type": "boolean", "description": "If this value is true, the container has read-only access to the volume.\n" } }, "type": "object", "required": [ "mountPath", "name", "readOnly" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyImagePullSecret:getJobDefinitionEksPropertyPodPropertyImagePullSecret": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainer:getJobDefinitionEksPropertyPodPropertyInitContainer": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "An array of arguments to the entrypoint\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "The command that's passed to the container.\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerEnv:getJobDefinitionEksPropertyPodPropertyInitContainerEnv" }, "description": "The environment variables to pass to a container. Array of EksContainerEnvironmentVariable objects.\n" }, "image": { "type": "string", "description": "The image used to start a container.\n" }, "imagePullPolicy": { "type": "string", "description": "The image pull policy for the container.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerResource:getJobDefinitionEksPropertyPodPropertyInitContainerResource" }, "description": "The type and amount of resources to assign to a container.\n" }, "securityContexts": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerSecurityContext:getJobDefinitionEksPropertyPodPropertyInitContainerSecurityContext" }, "description": "The security context for a job.\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerVolumeMount:getJobDefinitionEksPropertyPodPropertyInitContainerVolumeMount" }, "description": "The volume mounts for the container.\n" } }, "type": "object", "required": [ "args", "commands", "envs", "image", "imagePullPolicy", "name", "resources", "securityContexts", "volumeMounts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerEnv:getJobDefinitionEksPropertyPodPropertyInitContainerEnv": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "value": { "type": "string", "description": "The quantity of the specified resource to reserve for the container.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerResource:getJobDefinitionEksPropertyPodPropertyInitContainerResource": { "properties": { "limits": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The type and quantity of the resources to reserve for the container.\n" }, "requests": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The type and quantity of the resources to request for the container.\n" } }, "type": "object", "required": [ "limits", "requests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerSecurityContext:getJobDefinitionEksPropertyPodPropertyInitContainerSecurityContext": { "properties": { "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).\n" }, "readOnlyRootFileSystem": { "type": "boolean" }, "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.\n" }, "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.\n" }, "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.\n" } }, "type": "object", "required": [ "privileged", "readOnlyRootFileSystem", "runAsGroup", "runAsNonRoot", "runAsUser" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyInitContainerVolumeMount:getJobDefinitionEksPropertyPodPropertyInitContainerVolumeMount": { "properties": { "mountPath": { "type": "string", "description": "The path on the container where the volume is mounted.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "readOnly": { "type": "boolean", "description": "If this value is true, the container has read-only access to the volume.\n" } }, "type": "object", "required": [ "mountPath", "name", "readOnly" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyMetadata:getJobDefinitionEksPropertyPodPropertyMetadata": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pairs used to identify, sort, and organize cube resources.\n" } }, "type": "object", "required": [ "labels" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyVolume:getJobDefinitionEksPropertyPodPropertyVolume": { "properties": { "emptyDirs": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeEmptyDir:getJobDefinitionEksPropertyPodPropertyVolumeEmptyDir" }, "description": "Specifies the configuration of a Kubernetes emptyDir volume.\n" }, "hostPaths": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeHostPath:getJobDefinitionEksPropertyPodPropertyVolumeHostPath" }, "description": "The path for the device on the host container instance.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "secrets": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeSecret:getJobDefinitionEksPropertyPodPropertyVolumeSecret" }, "description": "Specifies the configuration of a Kubernetes secret volume.\n" } }, "type": "object", "required": [ "emptyDirs", "hostPaths", "name", "secrets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeEmptyDir:getJobDefinitionEksPropertyPodPropertyVolumeEmptyDir": { "properties": { "medium": { "type": "string", "description": "The medium to store the volume.\n" }, "sizeLimit": { "type": "string", "description": "The maximum size of the volume. By default, there's no maximum size defined.\n" } }, "type": "object", "required": [ "medium", "sizeLimit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeHostPath:getJobDefinitionEksPropertyPodPropertyVolumeHostPath": { "properties": { "path": { "type": "string", "description": "The path of the file or directory on the host to mount into containers on the pod.\n" } }, "type": "object", "required": [ "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionEksPropertyPodPropertyVolumeSecret:getJobDefinitionEksPropertyPodPropertyVolumeSecret": { "properties": { "optional": { "type": "boolean", "description": "Specifies whether the secret or the secret's keys must be defined.\n" }, "secretName": { "type": "string", "description": "The name of the secret. The name must be allowed as a DNS subdomain name\n" } }, "type": "object", "required": [ "optional", "secretName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodeProperty:getJobDefinitionNodeProperty": { "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.\n" }, "nodeRangeProperties": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangeProperty:getJobDefinitionNodePropertyNodeRangeProperty" }, "description": "A list of node ranges and their properties that are associated with a multi-node parallel job.\n" }, "numNodes": { "type": "integer", "description": "The number of nodes that are associated with a multi-node parallel job.\n" } }, "type": "object", "required": [ "mainNode", "nodeRangeProperties", "numNodes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangeProperty:getJobDefinitionNodePropertyNodeRangeProperty": { "properties": { "containers": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainer:getJobDefinitionNodePropertyNodeRangePropertyContainer" }, "description": "The container details for the node range.\n" }, "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. I\n" } }, "type": "object", "required": [ "containers", "targetNodes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainer:getJobDefinitionNodePropertyNodeRangePropertyContainer": { "properties": { "commands": { "type": "array", "items": { "type": "string" }, "description": "The command that's passed to the container.\n" }, "environments": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerEnvironment:getJobDefinitionNodePropertyNodeRangePropertyContainerEnvironment" }, "description": "The environment variables to pass to a container.\n" }, "ephemeralStorages": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerEphemeralStorage:getJobDefinitionNodePropertyNodeRangePropertyContainerEphemeralStorage" }, "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.\n" }, "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.\n" }, "fargatePlatformConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerFargatePlatformConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerFargatePlatformConfiguration" }, "description": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.\n" }, "image": { "type": "string", "description": "The image used to start a container.\n" }, "instanceType": { "type": "string", "description": "The instance type to use for a multi-node parallel job.\n" }, "jobRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.\n" }, "linuxParameters": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameter:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameter" }, "description": "Linux-specific modifications that are applied to the container.\n" }, "logConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfiguration" }, "description": "The log configuration specification for the container.\n" }, "mountPoints": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerMountPoint:getJobDefinitionNodePropertyNodeRangePropertyContainerMountPoint" }, "description": "The mount points for data volumes in your container.\n" }, "networkConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerNetworkConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerNetworkConfiguration" }, "description": "The network configuration for jobs that are running on Fargate resources.\n" }, "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).\n" }, "readonlyRootFilesystem": { "type": "boolean", "description": "When this parameter is true, the container is given read-only access to its root file system.\n" }, "resourceRequirements": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerResourceRequirement:getJobDefinitionNodePropertyNodeRangePropertyContainerResourceRequirement" }, "description": "The type and amount of resources to assign to a container.\n" }, "runtimePlatforms": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerRuntimePlatform:getJobDefinitionNodePropertyNodeRangePropertyContainerRuntimePlatform" }, "description": "An object that represents the compute environment architecture for AWS Batch jobs on Fargate.\n" }, "secrets": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerSecret:getJobDefinitionNodePropertyNodeRangePropertyContainerSecret" }, "description": "The secrets for the container.\n" }, "ulimits": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerUlimit:getJobDefinitionNodePropertyNodeRangePropertyContainerUlimit" }, "description": "A list of ulimits to set in the container.\n" }, "user": { "type": "string", "description": "The user name to use inside the container.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolume:getJobDefinitionNodePropertyNodeRangePropertyContainerVolume" }, "description": "A list of data volumes used in a job.\n" } }, "type": "object", "required": [ "commands", "environments", "ephemeralStorages", "executionRoleArn", "fargatePlatformConfigurations", "image", "instanceType", "jobRoleArn", "linuxParameters", "logConfigurations", "mountPoints", "networkConfigurations", "privileged", "readonlyRootFilesystem", "resourceRequirements", "runtimePlatforms", "secrets", "ulimits", "user", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerEnvironment:getJobDefinitionNodePropertyNodeRangePropertyContainerEnvironment": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "value": { "type": "string", "description": "The quantity of the specified resource to reserve for the container.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerEphemeralStorage:getJobDefinitionNodePropertyNodeRangePropertyContainerEphemeralStorage": { "properties": { "sizeInGib": { "type": "integer" } }, "type": "object", "required": [ "sizeInGib" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerFargatePlatformConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerFargatePlatformConfiguration": { "properties": { "platformVersion": { "type": "string", "description": "The AWS Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources.\n" } }, "type": "object", "required": [ "platformVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameter:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameter": { "properties": { "devices": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterDevice:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterDevice" }, "description": "Any of the host devices to expose to the container.\n" }, "initProcessEnabled": { "type": "boolean", "description": "If true, run an init process inside the container that forwards signals and reaps processes.\n" }, "maxSwap": { "type": "integer", "description": "The total amount of swap memory (in MiB) a container can use.\n" }, "sharedMemorySize": { "type": "integer", "description": "The value for the size (in MiB) of the `/dev/shm` volume.\n" }, "swappiness": { "type": "integer", "description": "You can use this parameter to tune a container's memory swappiness behavior.\n" }, "tmpfs": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterTmpf:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterTmpf" }, "description": "The container path, mount options, and size (in MiB) of the tmpfs mount.\n" } }, "type": "object", "required": [ "devices", "initProcessEnabled", "maxSwap", "sharedMemorySize", "swappiness", "tmpfs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterDevice:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterDevice": { "properties": { "containerPath": { "type": "string", "description": "The absolute file path in the container where the tmpfs volume is mounted.\n" }, "hostPath": { "type": "string", "description": "The path for the device on the host container instance.\n" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The explicit permissions to provide to the container for the device.\n" } }, "type": "object", "required": [ "containerPath", "hostPath", "permissions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterTmpf:getJobDefinitionNodePropertyNodeRangePropertyContainerLinuxParameterTmpf": { "properties": { "containerPath": { "type": "string", "description": "The absolute file path in the container where the tmpfs volume is mounted.\n" }, "mountOptions": { "type": "array", "items": { "type": "string" }, "description": "The list of tmpfs volume mount options.\n" }, "size": { "type": "integer", "description": "The size (in MiB) of the tmpfs volume.\n" } }, "type": "object", "required": [ "containerPath", "mountOptions", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfiguration": { "properties": { "logDriver": { "type": "string", "description": "The log driver to use for the container.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The configuration options to send to the log driver.\n" }, "secretOptions": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfigurationSecretOption:getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfigurationSecretOption" }, "description": "The secrets to pass to the log configuration.\n" } }, "type": "object", "required": [ "logDriver", "options", "secretOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfigurationSecretOption:getJobDefinitionNodePropertyNodeRangePropertyContainerLogConfigurationSecretOption": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "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" } }, "type": "object", "required": [ "name", "valueFrom" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerMountPoint:getJobDefinitionNodePropertyNodeRangePropertyContainerMountPoint": { "properties": { "containerPath": { "type": "string", "description": "The absolute file path in the container where the tmpfs volume is mounted.\n" }, "readOnly": { "type": "boolean", "description": "If this value is true, the container has read-only access to the volume.\n" }, "sourceVolume": { "type": "string", "description": "The name of the volume to mount.\n" } }, "type": "object", "required": [ "containerPath", "readOnly", "sourceVolume" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerNetworkConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerNetworkConfiguration": { "properties": { "assignPublicIp": { "type": "boolean", "description": "Indicates whether the job has a public IP address.\n" } }, "type": "object", "required": [ "assignPublicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerResourceRequirement:getJobDefinitionNodePropertyNodeRangePropertyContainerResourceRequirement": { "properties": { "type": { "type": "string", "description": "The type of resource to assign to a container. The supported resources include `GPU`, `MEMORY`, and `VCPU`.\n" }, "value": { "type": "string", "description": "The quantity of the specified resource to reserve for the container.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerRuntimePlatform:getJobDefinitionNodePropertyNodeRangePropertyContainerRuntimePlatform": { "properties": { "cpuArchitecture": { "type": "string", "description": "The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.\n" }, "operatingSystemFamily": { "type": "string", "description": "The operating system for the compute environment. V\n" } }, "type": "object", "required": [ "cpuArchitecture", "operatingSystemFamily" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerSecret:getJobDefinitionNodePropertyNodeRangePropertyContainerSecret": { "properties": { "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "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" } }, "type": "object", "required": [ "name", "valueFrom" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerUlimit:getJobDefinitionNodePropertyNodeRangePropertyContainerUlimit": { "properties": { "hardLimit": { "type": "integer", "description": "The hard limit for the ulimit type.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" }, "softLimit": { "type": "integer", "description": "The soft limit for the ulimit type.\n" } }, "type": "object", "required": [ "hardLimit", "name", "softLimit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolume:getJobDefinitionNodePropertyNodeRangePropertyContainerVolume": { "properties": { "efsVolumeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfiguration" }, "description": "This parameter is specified when you're using an Amazon Elastic File System file system for job storage.\n" }, "hosts": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeHost:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeHost" }, "description": "The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored.\n" }, "name": { "type": "string", "description": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).\n" } }, "type": "object", "required": [ "efsVolumeConfigurations", "hosts", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfiguration:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfiguration": { "properties": { "authorizationConfigs": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfigurationAuthorizationConfig:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfigurationAuthorizationConfig" }, "description": "The authorization configuration details for the Amazon EFS file system.\n" }, "fileSystemId": { "type": "string", "description": "The Amazon EFS file system ID to use.\n" }, "rootDirectory": { "type": "string", "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host.\n" }, "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\n" }, "transitEncryptionPort": { "type": "integer", "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.\n" } }, "type": "object", "required": [ "authorizationConfigs", "fileSystemId", "rootDirectory", "transitEncryption", "transitEncryptionPort" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfigurationAuthorizationConfig:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeEfsVolumeConfigurationAuthorizationConfig": { "properties": { "accessPointId": { "type": "string", "description": "The Amazon EFS access point ID to use.\n" }, "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.\n" } }, "type": "object", "required": [ "accessPointId", "iam" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeHost:getJobDefinitionNodePropertyNodeRangePropertyContainerVolumeHost": { "properties": { "sourcePath": { "type": "string", "description": "The path on the host container instance that's presented to the container.\n" } }, "type": "object", "required": [ "sourcePath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionRetryStrategy:getJobDefinitionRetryStrategy": { "properties": { "attempts": { "type": "integer", "description": "The number of times to move a job to the RUNNABLE status.\n" }, "evaluateOnExits": { "type": "array", "items": { "$ref": "#/types/aws:batch/getJobDefinitionRetryStrategyEvaluateOnExit:getJobDefinitionRetryStrategyEvaluateOnExit" }, "description": "Array of up to 5 objects that specify the conditions where jobs are retried or failed.\n" } }, "type": "object", "required": [ "attempts", "evaluateOnExits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionRetryStrategyEvaluateOnExit:getJobDefinitionRetryStrategyEvaluateOnExit": { "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.\n" }, "onExitCode": { "type": "string", "description": "Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.\n" }, "onReason": { "type": "string", "description": "Contains a glob pattern to match against the Reason returned for a job.\n" }, "onStatusReason": { "type": "string", "description": "Contains a glob pattern to match against the StatusReason returned for a job.\n" } }, "type": "object", "required": [ "action", "onExitCode", "onReason", "onStatusReason" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobDefinitionTimeout:getJobDefinitionTimeout": { "properties": { "attemptDurationSeconds": { "type": "integer", "description": "The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp.\n" } }, "type": "object", "required": [ "attemptDurationSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobQueueComputeEnvironmentOrder:getJobQueueComputeEnvironmentOrder": { "properties": { "computeEnvironment": { "type": "string" }, "order": { "type": "integer" } }, "type": "object", "required": [ "computeEnvironment", "order" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getJobQueueJobStateTimeLimitAction:getJobQueueJobStateTimeLimitAction": { "properties": { "action": { "type": "string" }, "maxTimeSeconds": { "type": "integer" }, "reason": { "type": "string" }, "state": { "type": "string", "description": "Describes the ability of the queue to accept new jobs (for example, `ENABLED` or `DISABLED`).\n" } }, "type": "object", "required": [ "action", "maxTimeSeconds", "reason", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getSchedulingPolicyFairSharePolicy:getSchedulingPolicyFairSharePolicy": { "properties": { "computeReservation": { "type": "integer", "description": "Value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used. For more information, see [FairsharePolicy](https://docs.aws.amazon.com/batch/latest/APIReference/API_FairsharePolicy.html).\n" }, "shareDecaySeconds": { "type": "integer" }, "shareDistributions": { "type": "array", "items": { "$ref": "#/types/aws:batch/getSchedulingPolicyFairSharePolicyShareDistribution:getSchedulingPolicyFairSharePolicyShareDistribution" }, "description": "One or more share distribution blocks which define the weights for the fair share identifiers for the fair share policy. For more information, see [FairsharePolicy](https://docs.aws.amazon.com/batch/latest/APIReference/API_FairsharePolicy.html). The `share_distribution` block is documented below.\n" } }, "type": "object", "required": [ "computeReservation", "shareDecaySeconds", "shareDistributions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:batch/getSchedulingPolicyFairSharePolicyShareDistribution:getSchedulingPolicyFairSharePolicyShareDistribution": { "properties": { "shareIdentifier": { "type": "string", "description": "Fair share identifier or fair share identifier prefix. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html).\n" }, "weightFactor": { "type": "number", "description": "Weight factor for the fair share identifier. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html).\n" } }, "type": "object", "required": [ "shareIdentifier", "weightFactor" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bcmdata/ExportExport:ExportExport": { "properties": { "dataQueries": { "type": "array", "items": { "$ref": "#/types/aws:bcmdata/ExportExportDataQuery:ExportExportDataQuery" }, "description": "Data query for this specific data export. See the `data_query` argument reference below.\n" }, "description": { "type": "string", "description": "Description for this specific data export.\n" }, "destinationConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bcmdata/ExportExportDestinationConfiguration:ExportExportDestinationConfiguration" }, "description": "Destination configuration for this specific data export. See the `destination_configurations` argument reference below.\n" }, "exportArn": { "type": "string", "description": "Amazon Resource Name (ARN) for this export.\n" }, "name": { "type": "string", "description": "Name of this specific data export.\n" }, "refreshCadences": { "type": "array", "items": { "$ref": "#/types/aws:bcmdata/ExportExportRefreshCadence:ExportExportRefreshCadence" }, "description": "Cadence for Amazon Web Services to update the export in your S3 bucket. See the `refresh_cadence` argument reference below.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "exportArn", "name" ] } } }, "aws:bcmdata/ExportExportDataQuery:ExportExportDataQuery": { "properties": { "queryStatement": { "type": "string", "description": "Query statement.\n" }, "tableConfigurations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "Table configuration.\n" } }, "type": "object", "required": [ "queryStatement" ] }, "aws:bcmdata/ExportExportDestinationConfiguration:ExportExportDestinationConfiguration": { "properties": { "s3Destinations": { "type": "array", "items": { "$ref": "#/types/aws:bcmdata/ExportExportDestinationConfigurationS3Destination:ExportExportDestinationConfigurationS3Destination" }, "description": "Object that describes the destination of the data exports file. See the `s3_destination` argument reference below.\n" } }, "type": "object" }, "aws:bcmdata/ExportExportDestinationConfigurationS3Destination:ExportExportDestinationConfigurationS3Destination": { "properties": { "s3Bucket": { "type": "string", "description": "Name of the Amazon S3 bucket used as the destination of a data export file.\n" }, "s3OutputConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bcmdata/ExportExportDestinationConfigurationS3DestinationS3OutputConfiguration:ExportExportDestinationConfigurationS3DestinationS3OutputConfiguration" }, "description": "Output configuration for the data export. See the `s3_output_configurations` argument reference below.\n" }, "s3Prefix": { "type": "string", "description": "S3 path prefix you want prepended to the name of your data export.\n" }, "s3Region": { "type": "string", "description": "S3 bucket region.\n" } }, "type": "object", "required": [ "s3Bucket", "s3Prefix", "s3Region" ] }, "aws:bcmdata/ExportExportDestinationConfigurationS3DestinationS3OutputConfiguration:ExportExportDestinationConfigurationS3DestinationS3OutputConfiguration": { "properties": { "compression": { "type": "string", "description": "Compression type for the data export. Valid values `GZIP`, `PARQUET`.\n" }, "format": { "type": "string", "description": "File format for the data export. Valid values `TEXT_OR_CSV` or `PARQUET`.\n" }, "outputType": { "type": "string", "description": "Output type for the data export. Valid value `CUSTOM`.\n" }, "overwrite": { "type": "string", "description": "The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time. Valid values `CREATE_NEW_REPORT` or `OVERWRITE_REPORT`.\n" } }, "type": "object", "required": [ "compression", "format", "outputType", "overwrite" ] }, "aws:bcmdata/ExportExportRefreshCadence:ExportExportRefreshCadence": { "properties": { "frequency": { "type": "string", "description": "Frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily. Valid values `SYNCHRONOUS`.\n" } }, "type": "object", "required": [ "frequency" ] }, "aws:bcmdata/ExportTimeouts:ExportTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupActionGroupExecutor:AgentAgentActionGroupActionGroupExecutor": { "properties": { "customControl": { "type": "string", "description": "Custom control method for handling the information elicited from the user. Valid values: `RETURN_CONTROL`.\nTo skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the `InvokeAgent` response, specify `RETURN_CONTROL`.\nOnly one of `custom_control` or `lambda` can be specified.\n" }, "lambda": { "type": "string", "description": "ARN of the Lambda function containing the business logic that is carried out upon invoking the action.\nOnly one of `lambda` or `custom_control` can be specified.\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupApiSchema:AgentAgentActionGroupApiSchema": { "properties": { "payload": { "type": "string", "description": "JSON or YAML-formatted payload defining the OpenAPI schema for the action group.\nOnly one of `payload` or `s3` can be specified.\n" }, "s3": { "$ref": "#/types/aws:bedrock/AgentAgentActionGroupApiSchemaS3:AgentAgentActionGroupApiSchemaS3", "description": "Details about the S3 object containing the OpenAPI schema for the action group. See `s3` Block for details.\nOnly one of `s3` or `payload` can be specified.\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupApiSchemaS3:AgentAgentActionGroupApiSchemaS3": { "properties": { "s3BucketName": { "type": "string", "description": "Name of the S3 bucket.\n" }, "s3ObjectKey": { "type": "string", "description": "S3 object key containing the resource.\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupFunctionSchema:AgentAgentActionGroupFunctionSchema": { "properties": { "memberFunctions": { "$ref": "#/types/aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctions:AgentAgentActionGroupFunctionSchemaMemberFunctions", "description": "Contains a list of functions.\nEach function describes and action in the action group.\nSee `member_functions` Block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctions:AgentAgentActionGroupFunctionSchemaMemberFunctions": { "properties": { "functions": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction:AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction" }, "description": "Functions that each define an action in the action group. See `functions` Block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction:AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction": { "properties": { "description": { "type": "string", "description": "Description of the function and its purpose.\n" }, "name": { "type": "string", "description": "Name for the function.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter:AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter" }, "description": "Parameters that the agent elicits from the user to fulfill the function. See `parameters` Block for details.\n" } }, "type": "object", "required": [ "name" ] }, "aws:bedrock/AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter:AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter": { "properties": { "description": { "type": "string", "description": "Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.\n" }, "mapBlockKey": { "type": "string", "description": "Name of the parameter.\n\n**Note:** The argument name `map_block_key` may seem out of context, but is necessary for backward compatibility reasons in the provider.\n" }, "required": { "type": "boolean", "description": "Whether the parameter is required for the agent to complete the function for action group invocation.\n" }, "type": { "type": "string", "description": "Data type of the parameter. Valid values: `string`, `number`, `integer`, `boolean`, `array`.\n" } }, "type": "object", "required": [ "mapBlockKey", "type" ] }, "aws:bedrock/AgentAgentActionGroupTimeouts:AgentAgentActionGroupTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentAgentAliasRoutingConfiguration:AgentAgentAliasRoutingConfiguration": { "properties": { "agentVersion": { "type": "string", "description": "Version of the agent with which the alias is associated.\n" }, "provisionedThroughput": { "type": "string", "description": "ARN of the Provisioned Throughput assigned to the agent alias.\n" } }, "type": "object", "required": [ "agentVersion", "provisionedThroughput" ] }, "aws:bedrock/AgentAgentAliasTimeouts:AgentAgentAliasTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentAgentCollaboratorAgentDescriptor:AgentAgentCollaboratorAgentDescriptor": { "properties": { "aliasArn": { "type": "string", "description": "ARN of the Alias of an Agent to use as the collaborator.\n" } }, "type": "object", "required": [ "aliasArn" ] }, "aws:bedrock/AgentAgentCollaboratorTimeouts:AgentAgentCollaboratorTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentAgentGuardrailConfiguration:AgentAgentGuardrailConfiguration": { "properties": { "guardrailIdentifier": { "type": "string", "description": "Unique identifier of the guardrail.\n" }, "guardrailVersion": { "type": "string", "description": "Version of the guardrail.\n" } }, "type": "object", "required": [ "guardrailIdentifier", "guardrailVersion" ] }, "aws:bedrock/AgentAgentKnowledgeBaseAssociationTimeouts:AgentAgentKnowledgeBaseAssociationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentAgentMemoryConfiguration:AgentAgentMemoryConfiguration": { "properties": { "enabledMemoryTypes": { "type": "array", "items": { "type": "string" }, "description": "The type of memory being stored by the agent. See [AWS API documentation](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_MemoryConfiguration.html) for possible values.\n" }, "storageDays": { "type": "integer", "description": "The number of days the agent is configured to retain the conversational context. Minimum value of 0, maximum value of 30.\n" } }, "type": "object", "required": [ "enabledMemoryTypes", "storageDays" ] }, "aws:bedrock/AgentAgentPromptOverrideConfiguration:AgentAgentPromptOverrideConfiguration": { "properties": { "overrideLambda": { "type": "string", "description": "ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `prompt_configurations` block must contain a `parser_mode` value that is set to `OVERRIDDEN`.\n" }, "promptConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentAgentPromptOverrideConfigurationPromptConfiguration:AgentAgentPromptOverrideConfigurationPromptConfiguration" }, "description": "Configurations to override a prompt template in one part of an agent sequence. See `prompt_configurations` Block for details.\n" } }, "type": "object", "required": [ "overrideLambda", "promptConfigurations" ] }, "aws:bedrock/AgentAgentPromptOverrideConfigurationPromptConfiguration:AgentAgentPromptOverrideConfigurationPromptConfiguration": { "properties": { "basePromptTemplate": { "type": "string", "description": "prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html).\n" }, "inferenceConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentAgentPromptOverrideConfigurationPromptConfigurationInferenceConfiguration:AgentAgentPromptOverrideConfigurationPromptConfigurationInferenceConfiguration" }, "description": "Inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `prompt_type`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). See `inference_configuration` Block for details.\n" }, "parserMode": { "type": "string", "description": "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 `prompt_type`. If you set the argument as `OVERRIDDEN`, the `override_lambda` argument in the `prompt_override_configuration` block must be specified with the ARN of a Lambda function. Valid values: `DEFAULT`, `OVERRIDDEN`.\n" }, "promptCreationMode": { "type": "string", "description": "Whether to override the default prompt template for this `prompt_type`. Set this argument to `OVERRIDDEN` to use the prompt that you provide in the `base_prompt_template`. If you leave it as `DEFAULT`, the agent uses a default prompt template. Valid values: `DEFAULT`, `OVERRIDDEN`.\n" }, "promptState": { "type": "string", "description": "Whether to allow the agent to carry out the step specified in the `prompt_type`. If you set this argument to `DISABLED`, the agent skips that step. Valid Values: `ENABLED`, `DISABLED`.\n" }, "promptType": { "type": "string", "description": "Step in the agent sequence that this prompt configuration applies to. Valid values: `PRE_PROCESSING`, `ORCHESTRATION`, `POST_PROCESSING`, `KNOWLEDGE_BASE_RESPONSE_GENERATION`.\n" } }, "type": "object", "required": [ "basePromptTemplate", "inferenceConfigurations", "parserMode", "promptCreationMode", "promptState", "promptType" ] }, "aws:bedrock/AgentAgentPromptOverrideConfigurationPromptConfigurationInferenceConfiguration:AgentAgentPromptOverrideConfigurationPromptConfigurationInferenceConfiguration": { "properties": { "maxLength": { "type": "integer", "description": "Maximum number of tokens to allow in the generated response.\n" }, "stopSequences": { "type": "array", "items": { "type": "string" }, "description": "List of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.\n" }, "temperature": { "type": "number", "description": "Likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.\n" }, "topK": { "type": "integer", "description": "Number of top most-likely candidates, between 0 and 500, from which the model chooses the next token in the sequence.\n" }, "topP": { "type": "number", "description": "Top percentage of the probability distribution of next tokens, between 0 and 1 (denoting 0% and 100%), from which the model chooses the next token in the sequence.\n" } }, "type": "object", "required": [ "maxLength", "stopSequences", "temperature", "topK", "topP" ] }, "aws:bedrock/AgentAgentTimeouts:AgentAgentTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfiguration:AgentDataSourceDataSourceConfiguration": { "properties": { "confluenceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfiguration", "description": "Details about the configuration of the Confluence data source. See `confluence_data_source_configuration` block for details.\n" }, "s3Configuration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationS3Configuration:AgentDataSourceDataSourceConfigurationS3Configuration", "description": "Details about the configuration of the S3 object containing the data source. See `s3_data_source_configuration` block for details.\n" }, "salesforceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfiguration", "description": "Details about the configuration of the Salesforce data source. See `salesforce_data_source_configuration` block for details.\n" }, "sharePointConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfiguration", "description": "Details about the configuration of the SharePoint data source. See `share_point_data_source_configuration` block for details.\n" }, "type": { "type": "string", "description": "Type of storage for the data source. Valid values: `S3`.\n" }, "webConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfiguration:AgentDataSourceDataSourceConfigurationWebConfiguration", "description": "Details about the configuration of the web data source. See `web_data_source_configuration` block for details.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfiguration": { "properties": { "crawlerConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfiguration" }, "sourceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationSourceConfiguration" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfiguration": { "properties": { "filterConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfiguration", "description": "The Salesforce standard object configuration. See `filter_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfiguration": { "properties": { "patternObjectFilters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter" }, "description": "The configuration of filtering certain objects or content types of the data source. See `pattern_object_filter` block for details.\n" }, "type": { "type": "string", "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.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter" }, "description": "The configuration of specific filters applied to your data source content. Minimum of 1 filter and maximum of 25 filters.\n\nEach filter object should contain the following configuration:\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationConfluenceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter": { "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.\n" } }, "type": "object", "required": [ "objectType" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationConfluenceConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationConfluenceConfigurationSourceConfiguration": { "properties": { "authType": { "type": "string", "description": "The supported authentication type to authenticate and connect to your SharePoint site. Valid values: `OAUTH2_CLIENT_CREDENTIALS`, `OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS`.\n" }, "credentialsSecretArn": { "type": "string", "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration. Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$.\n" }, "hostType": { "type": "string", "description": "The supported host type, whether online/cloud or server/on-premises. Valid values: `ONLINE`.\n" }, "hostUrl": { "type": "string", "description": "The Salesforce host URL or instance URL. Pattern: `^https://[A-Za-z0-9][^\\s]*$`.\n" } }, "type": "object", "required": [ "authType", "credentialsSecretArn", "hostType", "hostUrl" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationS3Configuration:AgentDataSourceDataSourceConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "ARN of the bucket that contains the data source.\n" }, "bucketOwnerAccountId": { "type": "string", "description": "Bucket account owner ID for the S3 bucket.\n" }, "inclusionPrefixes": { "type": "array", "items": { "type": "string" }, "description": "List of S3 prefixes that define the object containing the data sources. For more information, see [Organizing objects using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html).\n" } }, "type": "object", "required": [ "bucketArn" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfiguration": { "properties": { "crawlerConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfiguration" }, "sourceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationSourceConfiguration" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfiguration": { "properties": { "filterConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfiguration", "description": "The Salesforce standard object configuration. See `filter_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfiguration": { "properties": { "patternObjectFilters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter" }, "description": "The configuration of filtering certain objects or content types of the data source. See `pattern_object_filter` block for details.\n" }, "type": { "type": "string", "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.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter" }, "description": "The configuration of specific filters applied to your data source content. Minimum of 1 filter and maximum of 25 filters.\n\nEach filter object should contain the following configuration:\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationSalesforceConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter": { "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.\n" } }, "type": "object", "required": [ "objectType" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSalesforceConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationSalesforceConfigurationSourceConfiguration": { "properties": { "authType": { "type": "string", "description": "The supported authentication type to authenticate and connect to your SharePoint site. Valid values: `OAUTH2_CLIENT_CREDENTIALS`, `OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS`.\n" }, "credentialsSecretArn": { "type": "string", "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration. Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$.\n" }, "hostUrl": { "type": "string", "description": "The Salesforce host URL or instance URL. Pattern: `^https://[A-Za-z0-9][^\\s]*$`.\n" } }, "type": "object", "required": [ "authType", "credentialsSecretArn", "hostUrl" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfiguration": { "properties": { "crawlerConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfiguration" }, "sourceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationSourceConfiguration" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfiguration": { "properties": { "filterConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfiguration", "description": "The Salesforce standard object configuration. See `filter_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfiguration": { "properties": { "patternObjectFilters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter" }, "description": "The configuration of filtering certain objects or content types of the data source. See `pattern_object_filter` block for details.\n" }, "type": { "type": "string", "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.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilter": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter" }, "description": "The configuration of specific filters applied to your data source content. Minimum of 1 filter and maximum of 25 filters.\n\nEach filter object should contain the following configuration:\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter:AgentDataSourceDataSourceConfigurationSharePointConfigurationCrawlerConfigurationFilterConfigurationPatternObjectFilterFilter": { "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.\n" } }, "type": "object", "required": [ "objectType" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationSharePointConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationSharePointConfigurationSourceConfiguration": { "properties": { "authType": { "type": "string", "description": "The supported authentication type to authenticate and connect to your SharePoint site. Valid values: `OAUTH2_CLIENT_CREDENTIALS`, `OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS`.\n" }, "credentialsSecretArn": { "type": "string", "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration. Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$.\n" }, "domain": { "type": "string", "description": "The domain of your SharePoint instance or site URL/URLs.\n" }, "hostType": { "type": "string", "description": "The supported host type, whether online/cloud or server/on-premises. Valid values: `ONLINE`.\n" }, "siteUrls": { "type": "array", "items": { "type": "string" }, "description": "A list of one or more SharePoint site URLs.\n" }, "tenantId": { "type": "string", "description": "The identifier of your Microsoft 365 tenant.\n" } }, "type": "object", "required": [ "authType", "credentialsSecretArn", "domain", "hostType", "siteUrls" ] }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfiguration:AgentDataSourceDataSourceConfigurationWebConfiguration": { "properties": { "crawlerConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfiguration" }, "sourceConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfiguration" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfiguration": { "properties": { "crawlerLimits": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfigurationCrawlerLimits:AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfigurationCrawlerLimits", "description": "Configuration of crawl limits for the web URLs. See `crawler_limits` block for details.\n" }, "exclusionFilters": { "type": "array", "items": { "type": "string" }, "description": "List of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern.\n" }, "inclusionFilters": { "type": "array", "items": { "type": "string" }, "description": "List of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern.\n" }, "scope": { "type": "string", "description": "Scope of what is crawled for your URLs.\n" }, "userAgent": { "type": "string", "description": "String used for identifying the crawler or a bot when it accesses a web server. Default value is `bedrockbot_UUID`.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfigurationCrawlerLimits:AgentDataSourceDataSourceConfigurationWebConfigurationCrawlerConfigurationCrawlerLimits": { "properties": { "maxPages": { "type": "integer", "description": "Max number of web pages crawled from your source URLs, up to 25,000 pages.\n" }, "rateLimit": { "type": "integer", "description": "Max rate at which pages are crawled, up to 300 per minute per host.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfiguration": { "properties": { "urlConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfiguration", "description": "The URL configuration of your web data source. See `url_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfiguration:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfiguration": { "properties": { "seedUrls": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfigurationSeedUrl:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfigurationSeedUrl" }, "description": "List of one or more seed URLs to crawl. See `seed_urls` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfigurationSeedUrl:AgentDataSourceDataSourceConfigurationWebConfigurationSourceConfigurationUrlConfigurationSeedUrl": { "properties": { "url": { "type": "string", "description": "Seed or starting point URL. Must match the pattern `^https?://[A-Za-z0-9][^\\s]*$`.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceServerSideEncryptionConfiguration:AgentDataSourceServerSideEncryptionConfiguration": { "properties": { "kmsKeyArn": { "type": "string", "description": "ARN of the AWS KMS key used to encrypt the resource.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceTimeouts:AgentDataSourceTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceVectorIngestionConfiguration:AgentDataSourceVectorIngestionConfiguration": { "properties": { "chunkingConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfiguration", "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. See `chunking_configuration` block for details.\n" }, "customTransformationConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfiguration:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfiguration", "description": "Configuration for custom transformation of data source documents.\n" }, "parsingConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfiguration:AgentDataSourceVectorIngestionConfigurationParsingConfiguration", "description": "Configuration for custom parsing of data source documents. See `parsing_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfiguration": { "properties": { "chunkingStrategy": { "type": "string", "description": "Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: `FIXED_SIZE`, `HIERARCHICAL`, `SEMANTIC`, `NONE`.\n" }, "fixedSizeChunkingConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration", "description": "Configurations for when you choose fixed-size chunking. Requires chunking_strategy as `FIXED_SIZE`. See `fixed_size_chunking_configuration` for details.\n" }, "hierarchicalChunkingConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfiguration", "description": "Configurations for when you choose hierarchical chunking. Requires chunking_strategy as `HIERARCHICAL`. See `hierarchical_chunking_configuration` for details.\n" }, "semanticChunkingConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationSemanticChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationSemanticChunkingConfiguration", "description": "Configurations for when you choose semantic chunking. Requires chunking_strategy as `SEMANTIC`. See `semantic_chunking_configuration` for details.\n" } }, "type": "object", "required": [ "chunkingStrategy" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration": { "properties": { "maxTokens": { "type": "integer", "description": "Maximum number of tokens to include in a chunk.\n" }, "overlapPercentage": { "type": "integer", "description": "Percentage of overlap between adjacent chunks of a data source.\n" } }, "type": "object", "required": [ "maxTokens", "overlapPercentage" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfiguration": { "properties": { "levelConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfigurationLevelConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfigurationLevelConfiguration" }, "description": "Maximum number of tokens to include in a chunk. Must contain two `level_configurations`. See `level_configurations` for details.\n" }, "overlapTokens": { "type": "integer", "description": "The number of tokens to repeat across chunks in the same layer.\n" } }, "type": "object", "required": [ "levelConfigurations", "overlapTokens" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfigurationLevelConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationHierarchicalChunkingConfigurationLevelConfiguration": { "properties": { "maxTokens": { "type": "integer", "description": "The maximum number of tokens that a chunk can contain in this layer.\n" } }, "type": "object", "required": [ "maxTokens" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationChunkingConfigurationSemanticChunkingConfiguration:AgentDataSourceVectorIngestionConfigurationChunkingConfigurationSemanticChunkingConfiguration": { "properties": { "breakpointPercentileThreshold": { "type": "integer", "description": "The dissimilarity threshold for splitting chunks.\n" }, "bufferSize": { "type": "integer", "description": "The buffer size.\n" }, "maxToken": { "type": "integer", "description": "The maximum number of tokens a chunk can contain.\n" } }, "type": "object", "required": [ "breakpointPercentileThreshold", "bufferSize", "maxToken" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfiguration:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfiguration": { "properties": { "intermediateStorage": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorage:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorage", "description": "The intermediate storage for custom transformation.\n" }, "transformation": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformation:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformation", "description": "A custom processing step for documents moving through the data source ingestion pipeline.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorage:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorage": { "properties": { "s3Location": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorageS3Location:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorageS3Location", "description": "Configuration block for intermedia S3 storage.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorageS3Location:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationIntermediateStorageS3Location": { "properties": { "uri": { "type": "string", "description": "S3 URI for intermediate storage.\n" } }, "type": "object", "required": [ "uri" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformation:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformation": { "properties": { "stepToApply": { "type": "string", "description": "When the service applies the transformation. Currently only `POST_CHUNKING` is supported.\n" }, "transformationFunction": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunction:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunction", "description": "The lambda function that processes documents.\n" } }, "type": "object", "required": [ "stepToApply" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunction:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunction": { "properties": { "transformationLambdaConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunctionTransformationLambdaConfiguration:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunctionTransformationLambdaConfiguration", "description": "The configuration of the lambda function.\n" } }, "type": "object" }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunctionTransformationLambdaConfiguration:AgentDataSourceVectorIngestionConfigurationCustomTransformationConfigurationTransformationTransformationFunctionTransformationLambdaConfiguration": { "properties": { "lambdaArn": { "type": "string", "description": "The ARN of the lambda to use for custom transformation.\n" } }, "type": "object", "required": [ "lambdaArn" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfiguration:AgentDataSourceVectorIngestionConfigurationParsingConfiguration": { "properties": { "bedrockFoundationModelConfiguration": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfiguration:AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfiguration", "description": "Settings for a foundation model used to parse documents in a data source. See `bedrock_foundation_model_configuration` block for details.\n" }, "parsingStrategy": { "type": "string", "description": "Currently only `BEDROCK_FOUNDATION_MODEL` is supported\n" } }, "type": "object", "required": [ "parsingStrategy" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfiguration:AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfiguration": { "properties": { "modelArn": { "type": "string", "description": "The ARN of the model used to parse documents\n" }, "parsingPrompt": { "$ref": "#/types/aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfigurationParsingPrompt:AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfigurationParsingPrompt", "description": "Instructions for interpreting the contents of the document. See `parsing_prompt` block for details.\n" } }, "type": "object", "required": [ "modelArn" ] }, "aws:bedrock/AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfigurationParsingPrompt:AgentDataSourceVectorIngestionConfigurationParsingConfigurationBedrockFoundationModelConfigurationParsingPrompt": { "properties": { "parsingPromptString": { "type": "string", "description": "Instructions for interpreting the contents of the document.\n" } }, "type": "object", "required": [ "parsingPromptString" ] }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfiguration:AgentKnowledgeBaseKnowledgeBaseConfiguration": { "properties": { "type": { "type": "string", "description": "Type of data that the data source is converted into for the knowledge base. Valid Values: `VECTOR`.\n" }, "vectorKnowledgeBaseConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration", "description": "Details about the embeddings model that'sused to convert the data source. See `vector_knowledge_base_configuration` block for details.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration": { "properties": { "embeddingModelArn": { "type": "string", "description": "ARN of the model used to create vector embeddings for the knowledge base.\n" }, "embeddingModelConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration", "description": "The embeddings model configuration details for the vector model used in Knowledge Base. See `embedding_model_configuration` block for details.\n" }, "supplementalDataStorageConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration", "description": "supplemental_data_storage_configuration. See `supplemental_data_storage_configuration` block for details.\n" } }, "type": "object", "required": [ "embeddingModelArn" ] }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration": { "properties": { "bedrockEmbeddingModelConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration", "description": "The vector configuration details on the Bedrock embeddings model. See `bedrock_embedding_model_configuration` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration": { "properties": { "dimensions": { "type": "integer", "description": "Dimension details for the vector configuration used on the Bedrock embeddings model.\n" }, "embeddingDataType": { "type": "string", "description": "Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are `FLOAT32` and `BINARY`.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration": { "properties": { "storageLocations": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation" }, "description": "A storage location specification for images extracted from multimodal documents in your data source. See `storage_location` block for details.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation": { "properties": { "s3Location": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location", "description": "Contains information about the Amazon S3 location for the extracted images. See `s3_location` block for details.\n" }, "type": { "type": "string", "description": "Storage service used for this location. `S3` is the only valid value.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location:AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location": { "properties": { "uri": { "type": "string", "description": "URI of the location.\n" } }, "type": "object", "required": [ "uri" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfiguration:AgentKnowledgeBaseStorageConfiguration": { "properties": { "opensearchServerlessConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration:AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration", "description": "The storage configuration of the knowledge base in Amazon OpenSearch Service. See `opensearch_serverless_configuration` block for details.\n" }, "pineconeConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationPineconeConfiguration:AgentKnowledgeBaseStorageConfigurationPineconeConfiguration", "description": "The storage configuration of the knowledge base in Pinecone. See `pinecone_configuration` block for details.\n" }, "rdsConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationRdsConfiguration:AgentKnowledgeBaseStorageConfigurationRdsConfiguration", "description": "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.html). See `rds_configuration` block for details.\n" }, "redisEnterpriseCloudConfiguration": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration:AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration", "description": "The storage configuration of the knowledge base in Redis Enterprise Cloud. See `redis_enterprise_cloud_configuration` block for details.\n" }, "type": { "type": "string", "description": "Vector store service in which the knowledge base is stored. Valid Values: `OPENSEARCH_SERVERLESS`, `PINECONE`, `REDIS_ENTERPRISE_CLOUD`, `RDS`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration:AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration": { "properties": { "collectionArn": { "type": "string", "description": "ARN of the OpenSearch Service vector store.\n" }, "fieldMapping": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping", "description": "The names of the fields to which to map information about the vector store. This block supports the following arguments:\n" }, "vectorIndexName": { "type": "string", "description": "Name of the vector store.\n" } }, "type": "object", "required": [ "collectionArn", "vectorIndexName" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping": { "properties": { "metadataField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores metadata about the vector store.\n" }, "textField": { "type": "string", "description": "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.\n" }, "vectorField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationPineconeConfiguration:AgentKnowledgeBaseStorageConfigurationPineconeConfiguration": { "properties": { "connectionString": { "type": "string", "description": "Endpoint URL for your index management page.\n" }, "credentialsSecretArn": { "type": "string", "description": "ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.\n" }, "fieldMapping": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping", "description": "The names of the fields to which to map information about the vector store. This block supports the following arguments:\n" }, "namespace": { "type": "string", "description": "Namespace to be used to write new data to your database.\n" } }, "type": "object", "required": [ "connectionString", "credentialsSecretArn" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping": { "properties": { "metadataField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores metadata about the vector store.\n" }, "textField": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationRdsConfiguration:AgentKnowledgeBaseStorageConfigurationRdsConfiguration": { "properties": { "credentialsSecretArn": { "type": "string", "description": "ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.\n" }, "databaseName": { "type": "string", "description": "Name of your Amazon RDS database.\n" }, "fieldMapping": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping", "description": "Names of the fields to which to map information about the vector store. This block supports the following arguments:\n" }, "resourceArn": { "type": "string", "description": "ARN of the vector store.\n" }, "tableName": { "type": "string", "description": "Name of the table in the database.\n" } }, "type": "object", "required": [ "credentialsSecretArn", "databaseName", "resourceArn", "tableName" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping": { "properties": { "metadataField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores metadata about the vector store.\n" }, "primaryKeyField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores the ID for each entry.\n" }, "textField": { "type": "string", "description": "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.\n" }, "vectorField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n" } }, "type": "object", "required": [ "metadataField", "primaryKeyField", "textField", "vectorField" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration:AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration": { "properties": { "credentialsSecretArn": { "type": "string", "description": "ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.\n" }, "endpoint": { "type": "string", "description": "Endpoint URL of the Redis Enterprise Cloud database.\n" }, "fieldMapping": { "$ref": "#/types/aws:bedrock/AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping", "description": "The names of the fields to which to map information about the vector store. This block supports the following arguments:\n" }, "vectorIndexName": { "type": "string", "description": "Name of the vector index.\n" } }, "type": "object", "required": [ "credentialsSecretArn", "endpoint", "vectorIndexName" ] }, "aws:bedrock/AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping:AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping": { "properties": { "metadataField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores metadata about the vector store.\n" }, "textField": { "type": "string", "description": "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.\n" }, "vectorField": { "type": "string", "description": "Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n" } }, "type": "object" }, "aws:bedrock/AgentKnowledgeBaseTimeouts:AgentKnowledgeBaseTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/CustomModelOutputDataConfig:CustomModelOutputDataConfig": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the output data is stored.\n" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:bedrock/CustomModelTimeouts:CustomModelTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:bedrock/CustomModelTrainingDataConfig:CustomModelTrainingDataConfig": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the training data is stored.\n" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:bedrock/CustomModelTrainingMetric:CustomModelTrainingMetric": { "properties": { "trainingLoss": { "type": "number", "description": "Loss metric associated with the customization job.\n" } }, "type": "object", "required": [ "trainingLoss" ] }, "aws:bedrock/CustomModelValidationDataConfig:CustomModelValidationDataConfig": { "properties": { "validators": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/CustomModelValidationDataConfigValidator:CustomModelValidationDataConfigValidator" }, "description": "Information about the validators.\n" } }, "type": "object" }, "aws:bedrock/CustomModelValidationDataConfigValidator:CustomModelValidationDataConfigValidator": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the validation data is stored.\n" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:bedrock/CustomModelValidationMetric:CustomModelValidationMetric": { "properties": { "validationLoss": { "type": "number", "description": "The validation loss associated with the validator.\n" } }, "type": "object", "required": [ "validationLoss" ] }, "aws:bedrock/CustomModelVpcConfig:CustomModelVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "VPC configuration security group IDs.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "VPC configuration subnets.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds" ] }, "aws:bedrock/GuardrailContentPolicyConfig:GuardrailContentPolicyConfig": { "properties": { "filtersConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailContentPolicyConfigFiltersConfig:GuardrailContentPolicyConfigFiltersConfig" }, "description": "Set of content filter configs in content policy.\nSee Filters Config for more information.\n" } }, "type": "object" }, "aws:bedrock/GuardrailContentPolicyConfigFiltersConfig:GuardrailContentPolicyConfigFiltersConfig": { "properties": { "inputStrength": { "type": "string", "description": "Strength for filters.\n" }, "outputStrength": { "type": "string", "description": "Strength for filters.\n" }, "type": { "type": "string", "description": "Type of contextual grounding filter.\n" } }, "type": "object", "required": [ "inputStrength", "outputStrength", "type" ] }, "aws:bedrock/GuardrailContextualGroundingPolicyConfig:GuardrailContextualGroundingPolicyConfig": { "properties": { "filtersConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailContextualGroundingPolicyConfigFiltersConfig:GuardrailContextualGroundingPolicyConfigFiltersConfig" }, "description": "List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.\n" } }, "type": "object" }, "aws:bedrock/GuardrailContextualGroundingPolicyConfigFiltersConfig:GuardrailContextualGroundingPolicyConfigFiltersConfig": { "properties": { "threshold": { "type": "number", "description": "The threshold for this filter.\n" }, "type": { "type": "string", "description": "Type of contextual grounding filter.\n" } }, "type": "object", "required": [ "threshold", "type" ] }, "aws:bedrock/GuardrailSensitiveInformationPolicyConfig:GuardrailSensitiveInformationPolicyConfig": { "properties": { "piiEntitiesConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig:GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig" }, "description": "List of entities. See PII Entities Config for more information.\n" }, "regexesConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailSensitiveInformationPolicyConfigRegexesConfig:GuardrailSensitiveInformationPolicyConfigRegexesConfig" }, "description": "List of regex. See Regexes Config for more information.\n" } }, "type": "object" }, "aws:bedrock/GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig:GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig": { "properties": { "action": { "type": "string", "description": "Options for sensitive information action.\n" }, "type": { "type": "string", "description": "The currently supported PII entities.\n" } }, "type": "object", "required": [ "action", "type" ] }, "aws:bedrock/GuardrailSensitiveInformationPolicyConfigRegexesConfig:GuardrailSensitiveInformationPolicyConfigRegexesConfig": { "properties": { "action": { "type": "string", "description": "Options for sensitive information action.\n" }, "description": { "type": "string", "description": "The regex description.\n" }, "name": { "type": "string", "description": "The regex name.\n" }, "pattern": { "type": "string", "description": "The regex pattern.\n" } }, "type": "object", "required": [ "action", "name", "pattern" ], "language": { "nodejs": { "requiredOutputs": [ "action", "description", "name", "pattern" ] } } }, "aws:bedrock/GuardrailTimeouts:GuardrailTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/GuardrailTopicPolicyConfig:GuardrailTopicPolicyConfig": { "properties": { "topicsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailTopicPolicyConfigTopicsConfig:GuardrailTopicPolicyConfigTopicsConfig" }, "description": "List of topic configs in topic policy. See Topics Config for more information.\n" } }, "type": "object" }, "aws:bedrock/GuardrailTopicPolicyConfigTopicsConfig:GuardrailTopicPolicyConfigTopicsConfig": { "properties": { "definition": { "type": "string", "description": "Definition of topic in topic policy.\n" }, "examples": { "type": "array", "items": { "type": "string" }, "description": "List of text examples.\n" }, "name": { "type": "string", "description": "Name of topic in topic policy.\n" }, "type": { "type": "string", "description": "Type of topic in a policy.\n" } }, "type": "object", "required": [ "definition", "name", "type" ], "language": { "nodejs": { "requiredOutputs": [ "definition", "examples", "name", "type" ] } } }, "aws:bedrock/GuardrailVersionTimeouts:GuardrailVersionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:bedrock/GuardrailWordPolicyConfig:GuardrailWordPolicyConfig": { "properties": { "managedWordListsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailWordPolicyConfigManagedWordListsConfig:GuardrailWordPolicyConfigManagedWordListsConfig" }, "description": "A config for the list of managed words. See Managed Word Lists Config for more information.\n" }, "wordsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/GuardrailWordPolicyConfigWordsConfig:GuardrailWordPolicyConfigWordsConfig" }, "description": "List of custom word configs. See Words Config for more information.\n" } }, "type": "object" }, "aws:bedrock/GuardrailWordPolicyConfigManagedWordListsConfig:GuardrailWordPolicyConfigManagedWordListsConfig": { "properties": { "type": { "type": "string", "description": "Options for managed words.\n" } }, "type": "object", "required": [ "type" ] }, "aws:bedrock/GuardrailWordPolicyConfigWordsConfig:GuardrailWordPolicyConfigWordsConfig": { "properties": { "text": { "type": "string", "description": "The custom word text.\n" } }, "type": "object", "required": [ "text" ] }, "aws:bedrock/InferenceProfileModel:InferenceProfileModel": { "properties": { "modelArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the model.\n" } }, "type": "object", "required": [ "modelArn" ] }, "aws:bedrock/InferenceProfileModelSource:InferenceProfileModelSource": { "properties": { "copyFrom": { "type": "string", "description": "The Amazon Resource Name (ARN) of the model.\n" } }, "type": "object", "required": [ "copyFrom" ] }, "aws:bedrock/InferenceProfileTimeouts:InferenceProfileTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/ProvisionedModelThroughputTimeouts:ProvisionedModelThroughputTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:bedrock/getAgentAgentVersionsAgentVersionSummary:getAgentAgentVersionsAgentVersionSummary": { "properties": { "agentName": { "type": "string", "description": "Name of agent to which the version belongs.\n" }, "agentStatus": { "type": "string", "description": "Status of the agent to which the version belongs.\n" }, "agentVersion": { "type": "string", "description": "Version of the agent.\n" }, "createdAt": { "type": "string", "description": "Time at which the version was created.\n" }, "description": { "type": "string", "description": "Description of the version of the agent.\n* `GuardrailConfiguration` - Details aout the guardrail associated with the agent. See Guardrail Configuration\n" }, "guardrailConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/getAgentAgentVersionsAgentVersionSummaryGuardrailConfiguration:getAgentAgentVersionsAgentVersionSummaryGuardrailConfiguration" } }, "updatedAt": { "type": "string", "description": "Time at which the version was last updated.\n" } }, "type": "object", "required": [ "agentName", "agentStatus", "agentVersion", "createdAt", "description", "updatedAt" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getAgentAgentVersionsAgentVersionSummaryGuardrailConfiguration:getAgentAgentVersionsAgentVersionSummaryGuardrailConfiguration": { "properties": { "guardrailIdentifier": { "type": "string", "description": "Unique identifier of the guardrail.\n" }, "guardrailVersion": { "type": "string", "description": "Version of the guardrail.\n" } }, "type": "object", "required": [ "guardrailIdentifier", "guardrailVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelOutputDataConfig:getCustomModelOutputDataConfig": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the validation data is stored..\n" } }, "type": "object", "required": [ "s3Uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelTrainingDataConfig:getCustomModelTrainingDataConfig": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the validation data is stored..\n" } }, "type": "object", "required": [ "s3Uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelTrainingMetric:getCustomModelTrainingMetric": { "properties": { "trainingLoss": { "type": "number", "description": "Loss metric associated with the customization job.\n" } }, "type": "object", "required": [ "trainingLoss" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelValidationDataConfig:getCustomModelValidationDataConfig": { "properties": { "validators": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/getCustomModelValidationDataConfigValidator:getCustomModelValidationDataConfigValidator" }, "description": "Information about the validators.\n" } }, "type": "object", "required": [ "validators" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelValidationDataConfigValidator:getCustomModelValidationDataConfigValidator": { "properties": { "s3Uri": { "type": "string", "description": "The S3 URI where the validation data is stored..\n" } }, "type": "object", "required": [ "s3Uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelValidationMetric:getCustomModelValidationMetric": { "properties": { "validationLoss": { "type": "number", "description": "The validation loss associated with the validator.\n" } }, "type": "object", "required": [ "validationLoss" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getCustomModelsModelSummary:getCustomModelsModelSummary": { "properties": { "creationTime": { "type": "string", "description": "Creation time of the model.\n" }, "modelArn": { "type": "string", "description": "The ARN of the custom model.\n" }, "modelName": { "type": "string", "description": "The name of the custom model.\n" } }, "type": "object", "required": [ "creationTime", "modelArn", "modelName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getInferenceProfileModel:getInferenceProfileModel": { "properties": { "modelArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the model.\n" } }, "type": "object", "required": [ "modelArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getInferenceProfilesInferenceProfileSummary:getInferenceProfilesInferenceProfileSummary": { "properties": { "createdAt": { "type": "string", "description": "The time at which the inference profile was created.\n" }, "description": { "type": "string", "description": "The description of the inference profile.\n" }, "inferenceProfileArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the inference profile.\n" }, "inferenceProfileId": { "type": "string", "description": "The unique identifier of the inference profile.\n" }, "inferenceProfileName": { "type": "string", "description": "The name of the inference profile.\n" }, "models": { "type": "array", "items": { "$ref": "#/types/aws:bedrock/getInferenceProfilesInferenceProfileSummaryModel:getInferenceProfilesInferenceProfileSummaryModel" }, "description": "A list of information about each model in the inference profile. See `models`.\n" }, "status": { "type": "string", "description": "The status of the inference profile. `ACTIVE` means that the inference profile is available to use.\n" }, "type": { "type": "string", "description": "The type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock.\n" }, "updatedAt": { "type": "string", "description": "The time at which the inference profile was last updated.\n" } }, "type": "object", "required": [ "createdAt", "description", "inferenceProfileArn", "inferenceProfileId", "inferenceProfileName", "models", "status", "type", "updatedAt" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrock/getInferenceProfilesInferenceProfileSummaryModel:getInferenceProfilesInferenceProfileSummaryModel": { "properties": { "modelArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the model.\n" } }, "type": "object", "required": [ "modelArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrockfoundation/getModelsModelSummary:getModelsModelSummary": { "properties": { "customizationsSupporteds": { "type": "array", "items": { "type": "string" }, "description": "Customizations that the model supports.\n" }, "inferenceTypesSupporteds": { "type": "array", "items": { "type": "string" }, "description": "Inference types that the model supports.\n" }, "inputModalities": { "type": "array", "items": { "type": "string" }, "description": "Input modalities that the model supports.\n" }, "modelArn": { "type": "string", "description": "Model ARN.\n" }, "modelId": { "type": "string", "description": "Model identifier.\n" }, "modelName": { "type": "string", "description": "Model name.\n" }, "outputModalities": { "type": "array", "items": { "type": "string" }, "description": "Output modalities that the model supports.\n" }, "providerName": { "type": "string", "description": "Model provider name.\n" }, "responseStreamingSupported": { "type": "boolean", "description": "Indicates whether the model supports streaming.\n" } }, "type": "object", "required": [ "customizationsSupporteds", "inferenceTypesSupporteds", "inputModalities", "modelArn", "modelId", "modelName", "outputModalities", "providerName", "responseStreamingSupported" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfig:InvocationLoggingConfigurationLoggingConfig": { "properties": { "cloudwatchConfig": { "$ref": "#/types/aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigCloudwatchConfig:InvocationLoggingConfigurationLoggingConfigCloudwatchConfig", "description": "CloudWatch logging configuration. See `cloudwatch_config` Block for details.\n" }, "embeddingDataDeliveryEnabled": { "type": "boolean", "description": "Set to include embeddings data in the log delivery. Defaults to `true`.\n" }, "imageDataDeliveryEnabled": { "type": "boolean", "description": "Set to include image data in the log delivery. Defaults to `true`.\n" }, "s3Config": { "$ref": "#/types/aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigS3Config:InvocationLoggingConfigurationLoggingConfigS3Config", "description": "S3 configuration for storing log data. See `s3_config` Block for details.\n" }, "textDataDeliveryEnabled": { "type": "boolean", "description": "Set to include text data in the log delivery. Defaults to `true`.\n" }, "videoDataDeliveryEnabled": { "type": "boolean", "description": "Set to include text data in the log delivery. Defaults to `true`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "embeddingDataDeliveryEnabled", "imageDataDeliveryEnabled", "textDataDeliveryEnabled", "videoDataDeliveryEnabled" ] } } }, "aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigCloudwatchConfig:InvocationLoggingConfigurationLoggingConfigCloudwatchConfig": { "properties": { "largeDataDeliveryS3Config": { "$ref": "#/types/aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigCloudwatchConfigLargeDataDeliveryS3Config:InvocationLoggingConfigurationLoggingConfigCloudwatchConfigLargeDataDeliveryS3Config", "description": "S3 configuration for delivering a large amount of data. See `large_data_delivery_s3_config` Block for details.\n" }, "logGroupName": { "type": "string", "description": "Log group name.\n" }, "roleArn": { "type": "string", "description": "The role ARN.\n" } }, "type": "object" }, "aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigCloudwatchConfigLargeDataDeliveryS3Config:InvocationLoggingConfigurationLoggingConfigCloudwatchConfigLargeDataDeliveryS3Config": { "properties": { "bucketName": { "type": "string", "description": "S3 bucket name.\n" }, "keyPrefix": { "type": "string", "description": "S3 prefix.\n" } }, "type": "object" }, "aws:bedrockmodel/InvocationLoggingConfigurationLoggingConfigS3Config:InvocationLoggingConfigurationLoggingConfigS3Config": { "properties": { "bucketName": { "type": "string", "description": "S3 bucket name.\n" }, "keyPrefix": { "type": "string", "description": "S3 prefix.\n" } }, "type": "object" }, "aws:budgets/BudgetActionActionThreshold:BudgetActionActionThreshold": { "properties": { "actionThresholdType": { "type": "string", "description": "The type of threshold for a notification. Valid values are `PERCENTAGE` or `ABSOLUTE_VALUE`.\n" }, "actionThresholdValue": { "type": "number", "description": "The threshold of a notification.\n" } }, "type": "object", "required": [ "actionThresholdType", "actionThresholdValue" ] }, "aws:budgets/BudgetActionDefinition:BudgetActionDefinition": { "properties": { "iamActionDefinition": { "$ref": "#/types/aws:budgets/BudgetActionDefinitionIamActionDefinition:BudgetActionDefinitionIamActionDefinition", "description": "The AWS Identity and Access Management (IAM) action definition details. See IAM Action Definition.\n" }, "scpActionDefinition": { "$ref": "#/types/aws:budgets/BudgetActionDefinitionScpActionDefinition:BudgetActionDefinitionScpActionDefinition", "description": "The service control policies (SCPs) action definition details. See SCP Action Definition.\n" }, "ssmActionDefinition": { "$ref": "#/types/aws:budgets/BudgetActionDefinitionSsmActionDefinition:BudgetActionDefinitionSsmActionDefinition", "description": "The AWS Systems Manager (SSM) action definition details. See SSM Action Definition.\n" } }, "type": "object" }, "aws:budgets/BudgetActionDefinitionIamActionDefinition:BudgetActionDefinitionIamActionDefinition": { "properties": { "groups": { "type": "array", "items": { "type": "string" }, "description": "A list of groups to be attached. There must be at least one group.\n" }, "policyArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the policy to be attached.\n" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "A list of roles to be attached. There must be at least one role.\n" }, "users": { "type": "array", "items": { "type": "string" }, "description": "A list of users to be attached. There must be at least one user.\n" } }, "type": "object", "required": [ "policyArn" ] }, "aws:budgets/BudgetActionDefinitionScpActionDefinition:BudgetActionDefinitionScpActionDefinition": { "properties": { "policyId": { "type": "string", "description": "The policy ID attached.\n" }, "targetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of target IDs.\n" } }, "type": "object", "required": [ "policyId", "targetIds" ] }, "aws:budgets/BudgetActionDefinitionSsmActionDefinition:BudgetActionDefinitionSsmActionDefinition": { "properties": { "actionSubType": { "type": "string", "description": "The action subType. Valid values are `STOP_EC2_INSTANCES` or `STOP_RDS_INSTANCES`.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "The EC2 and RDS instance IDs.\n" }, "region": { "type": "string", "description": "The Region to run the SSM document.\n" } }, "type": "object", "required": [ "actionSubType", "instanceIds", "region" ] }, "aws:budgets/BudgetActionSubscriber:BudgetActionSubscriber": { "properties": { "address": { "type": "string", "description": "The address that AWS sends budget notifications to, either an SNS topic or an email.\n" }, "subscriptionType": { "type": "string", "description": "The type of notification that AWS sends to a subscriber. Valid values are `SNS` or `EMAIL`.\n" } }, "type": "object", "required": [ "address", "subscriptionType" ] }, "aws:budgets/BudgetAutoAdjustData:BudgetAutoAdjustData": { "properties": { "autoAdjustType": { "type": "string", "description": "(Required) - The string that defines whether your budget auto-adjusts based on historical or forecasted data. Valid values: `FORECAST`,`HISTORICAL`\n" }, "historicalOptions": { "$ref": "#/types/aws:budgets/BudgetAutoAdjustDataHistoricalOptions:BudgetAutoAdjustDataHistoricalOptions", "description": "(Optional) - Configuration block of Historical Options. Required for `auto_adjust_type` of `HISTORICAL` Configuration block that defines the historical data that your auto-adjusting budget is based on.\n" }, "lastAutoAdjustTime": { "type": "string", "description": "(Optional) - The last time that your budget was auto-adjusted.\n" } }, "type": "object", "required": [ "autoAdjustType" ], "language": { "nodejs": { "requiredOutputs": [ "autoAdjustType", "lastAutoAdjustTime" ] } } }, "aws:budgets/BudgetAutoAdjustDataHistoricalOptions:BudgetAutoAdjustDataHistoricalOptions": { "properties": { "budgetAdjustmentPeriod": { "type": "integer", "description": "(Required) - The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.\n" }, "lookbackAvailablePeriods": { "type": "integer", "description": "(Optional) - The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current budget limit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit. You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the `budget_adjustment_period` and your historical cost data.\n" } }, "type": "object", "required": [ "budgetAdjustmentPeriod" ], "language": { "nodejs": { "requiredOutputs": [ "budgetAdjustmentPeriod", "lookbackAvailablePeriods" ] } } }, "aws:budgets/BudgetCostFilter:BudgetCostFilter": { "properties": { "name": { "type": "string", "description": "The name of a budget. Unique within accounts.\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:budgets/BudgetCostTypes:BudgetCostTypes": { "properties": { "includeCredit": { "type": "boolean", "description": "A boolean value whether to include credits in the cost budget. Defaults to `true`\n" }, "includeDiscount": { "type": "boolean", "description": "Whether a budget includes discounts. Defaults to `true`\n" }, "includeOtherSubscription": { "type": "boolean", "description": "A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`\n" }, "includeRecurring": { "type": "boolean", "description": "A boolean value whether to include recurring costs in the cost budget. Defaults to `true`\n" }, "includeRefund": { "type": "boolean", "description": "A boolean value whether to include refunds in the cost budget. Defaults to `true`\n" }, "includeSubscription": { "type": "boolean", "description": "A boolean value whether to include subscriptions in the cost budget. Defaults to `true`\n" }, "includeSupport": { "type": "boolean", "description": "A boolean value whether to include support costs in the cost budget. Defaults to `true`\n" }, "includeTax": { "type": "boolean", "description": "A boolean value whether to include tax in the cost budget. Defaults to `true`\n" }, "includeUpfront": { "type": "boolean", "description": "A boolean value whether to include upfront costs in the cost budget. Defaults to `true`\n" }, "useAmortized": { "type": "boolean", "description": "Whether a budget uses the amortized rate. Defaults to `false`\n" }, "useBlended": { "type": "boolean", "description": "A boolean value whether to use blended costs in the cost budget. Defaults to `false`\n" } }, "type": "object" }, "aws:budgets/BudgetNotification:BudgetNotification": { "properties": { "comparisonOperator": { "type": "string", "description": "(Required) Comparison operator to use to evaluate the condition. Can be `LESS_THAN`, `EQUAL_TO` or `GREATER_THAN`.\n" }, "notificationType": { "type": "string", "description": "(Required) What kind of budget value to notify on. Can be `ACTUAL` or `FORECASTED`\n" }, "subscriberEmailAddresses": { "type": "array", "items": { "type": "string" }, "description": "(Optional) E-Mail addresses to notify. Either this or `subscriber_sns_topic_arns` is required.\n" }, "subscriberSnsTopicArns": { "type": "array", "items": { "type": "string" }, "description": "(Optional) SNS topics to notify. Either this or `subscriber_email_addresses` is required.\n" }, "threshold": { "type": "number", "description": "(Required) Threshold when the notification should be sent.\n" }, "thresholdType": { "type": "string", "description": "(Required) What kind of threshold is defined. Can be `PERCENTAGE` OR `ABSOLUTE_VALUE`.\n" } }, "type": "object", "required": [ "comparisonOperator", "notificationType", "threshold", "thresholdType" ] }, "aws:budgets/BudgetPlannedLimit:BudgetPlannedLimit": { "properties": { "amount": { "type": "string", "description": "(Required) The amount of cost or usage being measured for a budget.\n" }, "startTime": { "type": "string", "description": "(Required) The start time of the budget limit. Format: `2017-01-01_12:00`. See [PlannedBudgetLimits](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_Budget.html#awscostmanagement-Type-budgets_Budget-PlannedBudgetLimits) documentation.\n" }, "unit": { "type": "string", "description": "(Required) The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See [Spend](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-spend.html) documentation.\n" } }, "type": "object", "required": [ "amount", "startTime", "unit" ] }, "aws:budgets/getBudgetAutoAdjustData:getBudgetAutoAdjustData": { "properties": { "autoAdjustType": { "type": "string", "description": "(Required) - The string that defines whether your budget auto-adjusts based on historical or forecasted data. Valid values: `FORECAST`,`HISTORICAL`.\n" }, "historicalOptions": { "type": "array", "items": { "$ref": "#/types/aws:budgets/getBudgetAutoAdjustDataHistoricalOption:getBudgetAutoAdjustDataHistoricalOption" }, "description": "(Optional) - Configuration block of Historical Options. Required for `auto_adjust_type` of `HISTORICAL` Configuration block that defines the historical data that your auto-adjusting budget is based on.\n" }, "lastAutoAdjustTime": { "type": "string", "description": "(Optional) - The last time that your budget was auto-adjusted.\n" } }, "type": "object", "required": [ "autoAdjustType", "historicalOptions", "lastAutoAdjustTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetAutoAdjustDataHistoricalOption:getBudgetAutoAdjustDataHistoricalOption": { "properties": { "budgetAdjustmentPeriod": { "type": "integer", "description": "(Required) - The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.\n" }, "lookbackAvailablePeriods": { "type": "integer", "description": "(Optional) - The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current budget limit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit. You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the `budget_adjustment_period` and your historical cost data.\n" } }, "type": "object", "required": [ "budgetAdjustmentPeriod", "lookbackAvailablePeriods" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetBudgetLimit:getBudgetBudgetLimit": { "properties": { "amount": { "type": "string", "description": "The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" }, "unit": { "type": "string", "description": "The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" } }, "type": "object", "required": [ "amount", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetCalculatedSpend:getBudgetCalculatedSpend": { "properties": { "actualSpends": { "type": "array", "items": { "$ref": "#/types/aws:budgets/getBudgetCalculatedSpendActualSpend:getBudgetCalculatedSpendActualSpend" } } }, "type": "object", "required": [ "actualSpends" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetCalculatedSpendActualSpend:getBudgetCalculatedSpendActualSpend": { "properties": { "amount": { "type": "string", "description": "The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" }, "unit": { "type": "string", "description": "The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" } }, "type": "object", "required": [ "amount", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetCostFilter:getBudgetCostFilter": { "properties": { "name": { "type": "string", "description": "The name of a budget. Unique within accounts.\n\nThe following arguments are optional:\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetCostType:getBudgetCostType": { "properties": { "includeCredit": { "type": "boolean", "description": "A boolean value whether to include credits in the cost budget. Defaults to `true`.\n" }, "includeDiscount": { "type": "boolean", "description": "Whether a budget includes discounts. Defaults to `true`.\n" }, "includeOtherSubscription": { "type": "boolean", "description": "A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`.\n" }, "includeRecurring": { "type": "boolean", "description": "A boolean value whether to include recurring costs in the cost budget. Defaults to `true`.\n" }, "includeRefund": { "type": "boolean", "description": "A boolean value whether to include refunds in the cost budget. Defaults to `true`.\n" }, "includeSubscription": { "type": "boolean", "description": "A boolean value whether to include subscriptions in the cost budget. Defaults to `true`.\n" }, "includeSupport": { "type": "boolean", "description": "A boolean value whether to include support costs in the cost budget. Defaults to `true`.\n" }, "includeTax": { "type": "boolean", "description": "A boolean value whether to include tax in the cost budget. Defaults to `true`.\n" }, "includeUpfront": { "type": "boolean", "description": "A boolean value whether to include upfront costs in the cost budget. Defaults to `true`.\n" }, "useAmortized": { "type": "boolean", "description": "Whether a budget uses the amortized rate. Defaults to `false`.\n" }, "useBlended": { "type": "boolean", "description": "A boolean value whether to use blended costs in the cost budget. Defaults to `false`.\n" } }, "type": "object", "required": [ "includeCredit", "includeDiscount", "includeOtherSubscription", "includeRecurring", "includeRefund", "includeSubscription", "includeSupport", "includeTax", "includeUpfront", "useAmortized", "useBlended" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetNotification:getBudgetNotification": { "properties": { "comparisonOperator": { "type": "string", "description": "(Required) Comparison operator to use to evaluate the condition. Can be `LESS_THAN`, `EQUAL_TO` or `GREATER_THAN`.\n" }, "notificationType": { "type": "string", "description": "(Required) What kind of budget value to notify on. Can be `ACTUAL` or `FORECASTED`.\n" }, "subscriberEmailAddresses": { "type": "array", "items": { "type": "string" }, "description": "(Optional) E-Mail addresses to notify. Either this or `subscriber_sns_topic_arns` is required.\n" }, "subscriberSnsTopicArns": { "type": "array", "items": { "type": "string" }, "description": "(Optional) SNS topics to notify. Either this or `subscriber_email_addresses` is required.\n" }, "threshold": { "type": "number", "description": "(Required) Threshold when the notification should be sent.\n" }, "thresholdType": { "type": "string", "description": "(Required) What kind of threshold is defined. Can be `PERCENTAGE` OR `ABSOLUTE_VALUE`.\n" } }, "type": "object", "required": [ "comparisonOperator", "notificationType", "subscriberEmailAddresses", "subscriberSnsTopicArns", "threshold", "thresholdType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:budgets/getBudgetPlannedLimit:getBudgetPlannedLimit": { "properties": { "amount": { "type": "string", "description": "The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" }, "startTime": { "type": "string", "description": "(Required) The start time of the budget limit. Format: `2017-01-01_12:00`. See [PlannedBudgetLimits](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_Budget.html#awscostmanagement-Type-budgets_Budget-PlannedBudgetLimits) documentation.\n" }, "unit": { "type": "string", "description": "The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP. Length Constraints: Minimum length of `1`. Maximum length of `2147483647`.\n" } }, "type": "object", "required": [ "amount", "startTime", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cfg/ConfigurationAggregatorAccountAggregationSource:ConfigurationAggregatorAccountAggregationSource": { "properties": { "accountIds": { "type": "array", "items": { "type": "string" }, "description": "List of 12-digit account IDs of the account(s) being aggregated.\n" }, "allRegions": { "type": "boolean", "description": "If true, aggregate existing AWS Config regions and future regions.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of source regions being aggregated.\n\nEither `regions` or `all_regions` (as true) must be specified.\n" } }, "type": "object", "required": [ "accountIds" ] }, "aws:cfg/ConfigurationAggregatorOrganizationAggregationSource:ConfigurationAggregatorOrganizationAggregationSource": { "properties": { "allRegions": { "type": "boolean", "description": "If true, aggregate existing AWS Config regions and future regions.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of source regions being aggregated.\n" }, "roleArn": { "type": "string", "description": "ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.\n\nEither `regions` or `all_regions` (as true) must be specified.\n" } }, "type": "object", "required": [ "roleArn" ] }, "aws:cfg/ConformancePackInputParameter:ConformancePackInputParameter": { "properties": { "parameterName": { "type": "string", "description": "The input key.\n" }, "parameterValue": { "type": "string", "description": "The input value.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:cfg/DeliveryChannelSnapshotDeliveryProperties:DeliveryChannelSnapshotDeliveryProperties": { "properties": { "deliveryFrequency": { "type": "string", "description": "The frequency with which AWS Config recurringly delivers configuration snapshotsE.g., `One_Hour` or `Three_Hours`. Valid values are listed [here](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html#API_ConfigSnapshotDeliveryProperties_Contents).\n" } }, "type": "object" }, "aws:cfg/OrganizationConformancePackInputParameter:OrganizationConformancePackInputParameter": { "properties": { "parameterName": { "type": "string", "description": "The input key.\n" }, "parameterValue": { "type": "string", "description": "The input value.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:cfg/RecorderRecordingGroup:RecorderRecordingGroup": { "properties": { "allSupported": { "type": "boolean", "description": "Specifies whether AWS Config records configuration changes for every supported type of regional resource (which includes any new type that will become supported in the future). Conflicts with `resource_types`. Defaults to `true`.\n" }, "exclusionByResourceTypes": { "type": "array", "items": { "$ref": "#/types/aws:cfg/RecorderRecordingGroupExclusionByResourceType:RecorderRecordingGroupExclusionByResourceType" }, "description": "An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.To use this option, you must set the useOnly field of RecordingStrategy to `EXCLUSION_BY_RESOURCE_TYPES` Requires `all_supported = false`. Conflicts with `resource_types`.\n" }, "includeGlobalResourceTypes": { "type": "boolean", "description": "Specifies whether AWS Config includes all supported types of _global resources_ with the resources that it records. Requires `all_supported = true`. Conflicts with `resource_types`.\n" }, "recordingStrategies": { "type": "array", "items": { "$ref": "#/types/aws:cfg/RecorderRecordingGroupRecordingStrategy:RecorderRecordingGroupRecordingStrategy" }, "description": "Recording Strategy. Detailed below.\n" }, "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, `AWS::EC2::Instance` or `AWS::CloudTrail::Trail`). See [relevant part of AWS Docs](http://docs.aws.amazon.com/config/latest/APIReference/API_ResourceIdentifier.html#config-Type-ResourceIdentifier-resourceType) for available types. In order to use this attribute, `all_supported` must be set to false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "exclusionByResourceTypes", "recordingStrategies" ] } } }, "aws:cfg/RecorderRecordingGroupExclusionByResourceType:RecorderRecordingGroupExclusionByResourceType": { "properties": { "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list that specifies the types of AWS resources for which AWS Config excludes records configuration changes. See [relevant part of AWS Docs](http://docs.aws.amazon.com/config/latest/APIReference/API_ResourceIdentifier.html#config-Type-ResourceIdentifier-resourceType) for available types.\n" } }, "type": "object" }, "aws:cfg/RecorderRecordingGroupRecordingStrategy:RecorderRecordingGroupRecordingStrategy": { "properties": { "useOnly": { "type": "string" } }, "type": "object" }, "aws:cfg/RecorderRecordingMode:RecorderRecordingMode": { "properties": { "recordingFrequency": { "type": "string", "description": "Default recording frequency. `CONTINUOUS` or `DAILY`.\n" }, "recordingModeOverride": { "$ref": "#/types/aws:cfg/RecorderRecordingModeRecordingModeOverride:RecorderRecordingModeRecordingModeOverride", "description": "Recording mode overrides. Detailed below.\n" } }, "type": "object" }, "aws:cfg/RecorderRecordingModeRecordingModeOverride:RecorderRecordingModeRecordingModeOverride": { "properties": { "description": { "type": "string", "description": "A description you provide of the override.\n" }, "recordingFrequency": { "type": "string", "description": "The recording frequency for the resources in the override block. `CONTINUOUS` or `DAILY`.\n" }, "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list that specifies the types of AWS resources for which the override applies to. See [restrictions in the AWS Docs](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingModeOverride.html)\n" } }, "type": "object", "required": [ "recordingFrequency", "resourceTypes" ] }, "aws:cfg/RemediationConfigurationExecutionControls:RemediationConfigurationExecutionControls": { "properties": { "ssmControls": { "$ref": "#/types/aws:cfg/RemediationConfigurationExecutionControlsSsmControls:RemediationConfigurationExecutionControlsSsmControls", "description": "Configuration block for SSM controls. See below.\n" } }, "type": "object" }, "aws:cfg/RemediationConfigurationExecutionControlsSsmControls:RemediationConfigurationExecutionControlsSsmControls": { "properties": { "concurrentExecutionRatePercentage": { "type": "integer", "description": "Maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. The default value is 10%.\n" }, "errorPercentage": { "type": "integer", "description": "Percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. The default is 50%.\n" } }, "type": "object" }, "aws:cfg/RemediationConfigurationParameter:RemediationConfigurationParameter": { "properties": { "name": { "type": "string", "description": "Name of the attribute.\n" }, "resourceValue": { "type": "string", "description": "Value is dynamic and changes at run-time.\n" }, "staticValue": { "type": "string", "description": "Value is static and does not change at run-time.\n" }, "staticValues": { "type": "array", "items": { "type": "string" }, "description": "List of static values.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "name", "staticValues" ] } } }, "aws:cfg/RuleEvaluationMode:RuleEvaluationMode": { "properties": { "mode": { "type": "string", "description": "The mode of an evaluation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "mode" ] } } }, "aws:cfg/RuleScope:RuleScope": { "properties": { "complianceResourceId": { "type": "string", "description": "The IDs 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 `compliance_resource_types`.\n" }, "complianceResourceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of resource types of only those AWS resources that you want to trigger an evaluation for the ruleE.g., `AWS::EC2::Instance`. You can only specify one type if you also specify a resource ID for `compliance_resource_id`. See [relevant part of AWS Docs](http://docs.aws.amazon.com/config/latest/APIReference/API_ResourceIdentifier.html#config-Type-ResourceIdentifier-resourceType) for available types.\n" }, "tagKey": { "type": "string", "description": "The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.\n" }, "tagValue": { "type": "string", "description": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.\n" } }, "type": "object" }, "aws:cfg/RuleSource:RuleSource": { "properties": { "customPolicyDetails": { "$ref": "#/types/aws:cfg/RuleSourceCustomPolicyDetails:RuleSourceCustomPolicyDetails", "description": "Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to `CUSTOM_POLICY`. See Custom Policy Details Below.\n" }, "owner": { "type": "string", "description": "Indicates whether AWS or the customer owns and manages the AWS Config rule. Valid values are `AWS`, `CUSTOM_LAMBDA` or `CUSTOM_POLICY`. For more information about managed rules, see the [AWS Config Managed Rules documentation](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html). For more information about custom rules, see the [AWS Config Custom Rules documentation](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html). Custom Lambda Functions require permissions to allow the AWS Config service to invoke them, e.g., via the `aws.lambda.Permission` resource.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/aws:cfg/RuleSourceSourceDetail:RuleSourceSourceDetail" }, "description": "Provides the source and type of the event that causes AWS Config to evaluate your AWS resources. Only valid if `owner` is `CUSTOM_LAMBDA` or `CUSTOM_POLICY`. See Source Detail Below.\n" }, "sourceIdentifier": { "type": "string", "description": "For AWS Config managed rules, a predefined identifier, e.g `IAM_PASSWORD_POLICY`. For custom Lambda rules, the identifier is the ARN of the Lambda Function, such as `arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name` or the `arn` attribute of the `aws.lambda.Function` resource.\n" } }, "type": "object", "required": [ "owner" ] }, "aws:cfg/RuleSourceCustomPolicyDetails:RuleSourceCustomPolicyDetails": { "properties": { "enableDebugLogDelivery": { "type": "boolean", "description": "The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is `false`.\n" }, "policyRuntime": { "type": "string", "description": "The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://github.com/aws-cloudformation/cloudformation-guard).\n" }, "policyText": { "type": "string", "description": "The policy definition containing the logic for your Config Custom Policy rule.\n" } }, "type": "object", "required": [ "policyRuntime", "policyText" ] }, "aws:cfg/RuleSourceSourceDetail:RuleSourceSourceDetail": { "properties": { "eventSource": { "type": "string", "description": "The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWSresources. This defaults to `aws.config` and is the only valid value.\n" }, "maximumExecutionFrequency": { "type": "string", "description": "The frequency that you want AWS Config to run evaluations for a rule that istriggered periodically. If specified, requires `message_type` to be `ScheduledNotification`.\n" }, "messageType": { "type": "string", "description": "The type of notification that triggers AWS Config to run an evaluation for a rule. You canspecify the following notification types:\n* `ConfigurationItemChangeNotification` - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.\n* `OversizedConfigurationItemChangeNotification` - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config 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 `maximum_execution_frequency`.\n* `ConfigurationSnapshotDeliveryCompleted` - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.\n" } }, "type": "object" }, "aws:chatbot/SlackChannelConfigurationTimeouts:SlackChannelConfigurationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:chatbot/TeamsChannelConfigurationTimeouts:TeamsChannelConfigurationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:chime/SdkvoiceGlobalSettingsVoiceConnector:SdkvoiceGlobalSettingsVoiceConnector": { "properties": { "cdrBucket": { "type": "string", "description": "The S3 bucket that stores the Voice Connector's call detail records.\n" } }, "type": "object" }, "aws:chime/SdkvoiceSipMediaApplicationEndpoints:SdkvoiceSipMediaApplicationEndpoints": { "properties": { "lambdaArn": { "type": "string", "description": "Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.\n" } }, "type": "object", "required": [ "lambdaArn" ] }, "aws:chime/SdkvoiceSipRuleTargetApplication:SdkvoiceSipRuleTargetApplication": { "properties": { "awsRegion": { "type": "string", "description": "The AWS Region of the target application.\n", "willReplaceOnChanges": true }, "priority": { "type": "integer", "description": "Priority of the SIP media application in the target list.\n" }, "sipMediaApplicationId": { "type": "string", "description": "The SIP media application ID.\n" } }, "type": "object", "required": [ "awsRegion", "priority", "sipMediaApplicationId" ] }, "aws:chime/SdkvoiceVoiceProfileDomainServerSideEncryptionConfiguration:SdkvoiceVoiceProfileDomainServerSideEncryptionConfiguration": { "properties": { "kmsKeyArn": { "type": "string", "description": "ARN for KMS Key.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "kmsKeyArn" ] }, "aws:chime/VoiceConnectorGroupConnector:VoiceConnectorGroupConnector": { "properties": { "priority": { "type": "integer", "description": "The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.\n" }, "voiceConnectorId": { "type": "string", "description": "The Amazon Chime Voice Connector ID.\n" } }, "type": "object", "required": [ "priority", "voiceConnectorId" ] }, "aws:chime/VoiceConnectorOrganizationRoute:VoiceConnectorOrganizationRoute": { "properties": { "host": { "type": "string", "description": "The FQDN or IP address to contact for origination traffic.\n" }, "port": { "type": "integer", "description": "The designated origination route port. Defaults to `5060`.\n" }, "priority": { "type": "integer", "description": "The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.\n" }, "protocol": { "type": "string", "description": "The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.\n" }, "weight": { "type": "integer", "description": "The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.\n" } }, "type": "object", "required": [ "host", "priority", "protocol", "weight" ] }, "aws:chime/VoiceConnectorOriginationRoute:VoiceConnectorOriginationRoute": { "properties": { "host": { "type": "string", "description": "The FQDN or IP address to contact for origination traffic.\n" }, "port": { "type": "integer", "description": "The designated origination route port. Defaults to `5060`.\n" }, "priority": { "type": "integer", "description": "The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.\n" }, "protocol": { "type": "string", "description": "The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.\n" }, "weight": { "type": "integer", "description": "The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.\n" } }, "type": "object", "required": [ "host", "priority", "protocol", "weight" ] }, "aws:chime/VoiceConnectorStreamingMediaInsightsConfiguration:VoiceConnectorStreamingMediaInsightsConfiguration": { "properties": { "configurationArn": { "type": "string", "description": "The media insights configuration that will be invoked by the Voice Connector.\n" }, "disabled": { "type": "boolean", "description": "When `true`, the media insights configuration is not enabled. Defaults to `false`.\n" } }, "type": "object" }, "aws:chime/VoiceConnectorTerminationCredentialsCredential:VoiceConnectorTerminationCredentialsCredential": { "properties": { "password": { "type": "string", "description": "RFC2617 compliant password associated with the SIP credentials.\n", "secret": true }, "username": { "type": "string", "description": "RFC2617 compliant username associated with the SIP credentials.\n" } }, "type": "object", "required": [ "password", "username" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElement:MediaInsightsPipelineConfigurationElement": { "properties": { "amazonTranscribeCallAnalyticsProcessorConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfiguration:MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfiguration", "description": "Configuration for Amazon Transcribe Call Analytics processor.\n" }, "amazonTranscribeProcessorConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeProcessorConfiguration:MediaInsightsPipelineConfigurationElementAmazonTranscribeProcessorConfiguration", "description": "Configuration for Amazon Transcribe processor.\n" }, "kinesisDataStreamSinkConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementKinesisDataStreamSinkConfiguration:MediaInsightsPipelineConfigurationElementKinesisDataStreamSinkConfiguration", "description": "Configuration for Kinesis Data Stream sink.\n" }, "lambdaFunctionSinkConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementLambdaFunctionSinkConfiguration:MediaInsightsPipelineConfigurationElementLambdaFunctionSinkConfiguration", "description": "Configuration for Lambda Function sink.\n" }, "s3RecordingSinkConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementS3RecordingSinkConfiguration:MediaInsightsPipelineConfigurationElementS3RecordingSinkConfiguration", "description": "Configuration for S3 recording sink.\n" }, "snsTopicSinkConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementSnsTopicSinkConfiguration:MediaInsightsPipelineConfigurationElementSnsTopicSinkConfiguration", "description": "Configuration for SNS Topic sink.\n" }, "sqsQueueSinkConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementSqsQueueSinkConfiguration:MediaInsightsPipelineConfigurationElementSqsQueueSinkConfiguration", "description": "Configuration for SQS Queue sink.\n" }, "type": { "type": "string", "description": "Element type.\n" }, "voiceAnalyticsProcessorConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementVoiceAnalyticsProcessorConfiguration:MediaInsightsPipelineConfigurationElementVoiceAnalyticsProcessorConfiguration", "description": "Configuration for Voice analytics processor.\n" } }, "type": "object", "required": [ "type" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfiguration:MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfiguration": { "properties": { "callAnalyticsStreamCategories": { "type": "array", "items": { "type": "string" }, "description": "Filter for category events to be delivered to insights target.\n" }, "contentIdentificationType": { "type": "string", "description": "Labels all personally identifiable information (PII) identified in Utterance events.\n" }, "contentRedactionType": { "type": "string", "description": "Redacts all personally identifiable information (PII) identified in Utterance events.\n" }, "enablePartialResultsStabilization": { "type": "boolean", "description": "Enables partial result stabilization in Utterance events.\n" }, "filterPartialResults": { "type": "boolean", "description": "Filters partial Utterance events from delivery to the insights target.\n" }, "languageCode": { "type": "string", "description": "Language code for the transcription model.\n" }, "languageModelName": { "type": "string", "description": "Name of custom language model for transcription.\n" }, "partialResultsStability": { "type": "string", "description": "Level of stability to use when partial results stabilization is enabled.\n" }, "piiEntityTypes": { "type": "string", "description": "Types of personally identifiable information (PII) to redact from an Utterance event.\n" }, "postCallAnalyticsSettings": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfigurationPostCallAnalyticsSettings:MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfigurationPostCallAnalyticsSettings", "description": "Settings for post call analytics.\n" }, "vocabularyFilterMethod": { "type": "string", "description": "Method for applying a vocabulary filter to Utterance events.\n" }, "vocabularyFilterName": { "type": "string", "description": "Name of the custom vocabulary filter to use when processing Utterance events.\n" }, "vocabularyName": { "type": "string", "description": "Name of the custom vocabulary to use when processing Utterance events.\n" } }, "type": "object", "required": [ "languageCode" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfigurationPostCallAnalyticsSettings:MediaInsightsPipelineConfigurationElementAmazonTranscribeCallAnalyticsProcessorConfigurationPostCallAnalyticsSettings": { "properties": { "contentRedactionOutput": { "type": "string", "description": "Should output be redacted.\n" }, "dataAccessRoleArn": { "type": "string", "description": "ARN of the role used by AWS Transcribe to upload your post call analysis.\n" }, "outputEncryptionKmsKeyId": { "type": "string", "description": "ID of the KMS key used to encrypt the output.\n" }, "outputLocation": { "type": "string", "description": "The Amazon S3 location where you want your Call Analytics post-call transcription output stored.\n" } }, "type": "object", "required": [ "dataAccessRoleArn", "outputLocation" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementAmazonTranscribeProcessorConfiguration:MediaInsightsPipelineConfigurationElementAmazonTranscribeProcessorConfiguration": { "properties": { "contentIdentificationType": { "type": "string", "description": "Labels all personally identifiable information (PII) identified in Transcript events.\n" }, "contentRedactionType": { "type": "string", "description": "Redacts all personally identifiable information (PII) identified in Transcript events.\n" }, "enablePartialResultsStabilization": { "type": "boolean", "description": "Enables partial result stabilization in Transcript events.\n" }, "filterPartialResults": { "type": "boolean", "description": "Filters partial Utterance events from delivery to the insights target.\n" }, "languageCode": { "type": "string", "description": "Language code for the transcription model.\n" }, "languageModelName": { "type": "string", "description": "Name of custom language model for transcription.\n" }, "partialResultsStability": { "type": "string", "description": "Level of stability to use when partial results stabilization is enabled.\n" }, "piiEntityTypes": { "type": "string", "description": "Types of personally identifiable information (PII) to redact from a Transcript event.\n" }, "showSpeakerLabel": { "type": "boolean", "description": "Enables speaker partitioning (diarization) in your Transcript events.\n" }, "vocabularyFilterMethod": { "type": "string", "description": "Method for applying a vocabulary filter to Transcript events.\n" }, "vocabularyFilterName": { "type": "string", "description": "Name of the custom vocabulary filter to use when processing Transcript events.\n" }, "vocabularyName": { "type": "string", "description": "Name of the custom vocabulary to use when processing Transcript events.\n" } }, "type": "object", "required": [ "languageCode" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementKinesisDataStreamSinkConfiguration:MediaInsightsPipelineConfigurationElementKinesisDataStreamSinkConfiguration": { "properties": { "insightsTarget": { "type": "string", "description": "Kinesis Data Stream to deliver results.\n" } }, "type": "object", "required": [ "insightsTarget" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementLambdaFunctionSinkConfiguration:MediaInsightsPipelineConfigurationElementLambdaFunctionSinkConfiguration": { "properties": { "insightsTarget": { "type": "string", "description": "Lambda Function to deliver results.\n" } }, "type": "object", "required": [ "insightsTarget" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementS3RecordingSinkConfiguration:MediaInsightsPipelineConfigurationElementS3RecordingSinkConfiguration": { "properties": { "destination": { "type": "string", "description": "S3 URI to deliver recordings.\n" } }, "type": "object" }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementSnsTopicSinkConfiguration:MediaInsightsPipelineConfigurationElementSnsTopicSinkConfiguration": { "properties": { "insightsTarget": { "type": "string", "description": "SNS topic to deliver results.\n" } }, "type": "object", "required": [ "insightsTarget" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementSqsQueueSinkConfiguration:MediaInsightsPipelineConfigurationElementSqsQueueSinkConfiguration": { "properties": { "insightsTarget": { "type": "string", "description": "SQS queue to deliver results.\n" } }, "type": "object", "required": [ "insightsTarget" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationElementVoiceAnalyticsProcessorConfiguration:MediaInsightsPipelineConfigurationElementVoiceAnalyticsProcessorConfiguration": { "properties": { "speakerSearchStatus": { "type": "string", "description": "Enable speaker search.\n" }, "voiceToneAnalysisStatus": { "type": "string", "description": "Enable voice tone analysis.\n" } }, "type": "object", "required": [ "speakerSearchStatus", "voiceToneAnalysisStatus" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfiguration": { "properties": { "disabled": { "type": "boolean", "description": "Disables real time alert rules.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRule:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRule" }, "description": "Collection of real time alert rules\n" } }, "type": "object", "required": [ "rules" ], "language": { "nodejs": { "requiredOutputs": [ "disabled", "rules" ] } } }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRule:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRule": { "properties": { "issueDetectionConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleIssueDetectionConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleIssueDetectionConfiguration", "description": "Configuration for an issue detection rule.\n" }, "keywordMatchConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleKeywordMatchConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleKeywordMatchConfiguration", "description": "Configuration for a keyword match rule.\n" }, "sentimentConfiguration": { "$ref": "#/types/aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleSentimentConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleSentimentConfiguration", "description": "Configuration for a sentiment rule.\n" }, "type": { "type": "string", "description": "Rule type.\n" } }, "type": "object", "required": [ "type" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleIssueDetectionConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleIssueDetectionConfiguration": { "properties": { "ruleName": { "type": "string", "description": "Rule name.\n" } }, "type": "object", "required": [ "ruleName" ] }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleKeywordMatchConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleKeywordMatchConfiguration": { "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Collection of keywords to match.\n" }, "negate": { "type": "boolean", "description": "Negate the rule.\n" }, "ruleName": { "type": "string", "description": "Rule name.\n" } }, "type": "object", "required": [ "keywords", "ruleName" ], "language": { "nodejs": { "requiredOutputs": [ "keywords", "negate", "ruleName" ] } } }, "aws:chimesdkmediapipelines/MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleSentimentConfiguration:MediaInsightsPipelineConfigurationRealTimeAlertConfigurationRuleSentimentConfiguration": { "properties": { "ruleName": { "type": "string", "description": "Rule name.\n" }, "sentimentType": { "type": "string", "description": "Sentiment type to match.\n" }, "timePeriod": { "type": "integer", "description": "Analysis interval.\n" } }, "type": "object", "required": [ "ruleName", "sentimentType", "timePeriod" ] }, "aws:cleanrooms/CollaborationDataEncryptionMetadata:CollaborationDataEncryptionMetadata": { "properties": { "allowClearText": { "type": "boolean", "willReplaceOnChanges": true }, "allowDuplicates": { "type": "boolean", "willReplaceOnChanges": true }, "allowJoinsOnColumnsWithDifferentNames": { "type": "boolean", "willReplaceOnChanges": true }, "preserveNulls": { "type": "boolean", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allowClearText", "allowDuplicates", "allowJoinsOnColumnsWithDifferentNames", "preserveNulls" ] }, "aws:cleanrooms/CollaborationMember:CollaborationMember": { "properties": { "accountId": { "type": "string", "willReplaceOnChanges": true }, "displayName": { "type": "string", "willReplaceOnChanges": true }, "memberAbilities": { "type": "array", "items": { "type": "string" }, "willReplaceOnChanges": true }, "status": { "type": "string" } }, "type": "object", "required": [ "accountId", "displayName", "memberAbilities" ], "language": { "nodejs": { "requiredOutputs": [ "accountId", "displayName", "memberAbilities", "status" ] } } }, "aws:cleanrooms/ConfiguredTableTableReference:ConfiguredTableTableReference": { "properties": { "databaseName": { "type": "string", "willReplaceOnChanges": true }, "tableName": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName", "tableName" ] }, "aws:cleanrooms/MembershipDefaultResultConfiguration:MembershipDefaultResultConfiguration": { "properties": { "outputConfiguration": { "$ref": "#/types/aws:cleanrooms/MembershipDefaultResultConfigurationOutputConfiguration:MembershipDefaultResultConfigurationOutputConfiguration" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role which will be used to create the membership.\n- `output_configuration.s3.bucket` - (Required) - The name of the S3 bucket where the query results will be stored.\n- `output_configuration.s3.result_format` - (Required) - The format of the query results. Valid values are `PARQUET` and `CSV`.\n- `output_configuration.s3.key_prefix` - (Optional) - The prefix used for the query results.\n" } }, "type": "object" }, "aws:cleanrooms/MembershipDefaultResultConfigurationOutputConfiguration:MembershipDefaultResultConfigurationOutputConfiguration": { "properties": { "s3": { "$ref": "#/types/aws:cleanrooms/MembershipDefaultResultConfigurationOutputConfigurationS3:MembershipDefaultResultConfigurationOutputConfigurationS3" } }, "type": "object" }, "aws:cleanrooms/MembershipDefaultResultConfigurationOutputConfigurationS3:MembershipDefaultResultConfigurationOutputConfigurationS3": { "properties": { "bucket": { "type": "string" }, "keyPrefix": { "type": "string" }, "resultFormat": { "type": "string" } }, "type": "object", "required": [ "bucket", "resultFormat" ] }, "aws:cleanrooms/MembershipPaymentConfiguration:MembershipPaymentConfiguration": { "properties": { "queryCompute": { "$ref": "#/types/aws:cleanrooms/MembershipPaymentConfigurationQueryCompute:MembershipPaymentConfigurationQueryCompute" } }, "type": "object" }, "aws:cleanrooms/MembershipPaymentConfigurationQueryCompute:MembershipPaymentConfigurationQueryCompute": { "properties": { "isResponsible": { "type": "boolean", "description": "Indicates whether the collaboration member has accepted to pay for query compute costs.\n" } }, "type": "object", "required": [ "isResponsible" ] }, "aws:cloudformation/CloudFormationTypeLoggingConfig:CloudFormationTypeLoggingConfig": { "properties": { "logGroupName": { "type": "string", "description": "Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.\n", "willReplaceOnChanges": true }, "logRoleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "logGroupName", "logRoleArn" ] }, "aws:cloudformation/StackInstancesDeploymentTargets:StackInstancesDeploymentTargets": { "properties": { "accountFilterType": { "type": "string", "description": "Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: `INTERSECTION`, `DIFFERENCE`, `UNION`, `NONE`.\n", "willReplaceOnChanges": true }, "accounts": { "type": "array", "items": { "type": "string" }, "description": "List of accounts to deploy stack set updates.\n" }, "accountsUrl": { "type": "string", "description": "S3 URL of the file containing the list of accounts.\n" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string" }, "description": "Organization root ID or organizational unit (OU) IDs to which stack sets deploy.\n" } }, "type": "object" }, "aws:cloudformation/StackInstancesOperationPreferences:StackInstancesOperationPreferences": { "properties": { "concurrencyMode": { "type": "string", "description": "How the concurrency level behaves during the operation execution. Valid values are `STRICT_FAILURE_TOLERANCE` and `SOFT_FAILURE_TOLERANCE`.\n" }, "failureToleranceCount": { "type": "integer", "description": "Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.\n" }, "failureTolerancePercentage": { "type": "integer", "description": "Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.\n" }, "maxConcurrentCount": { "type": "integer", "description": "Maximum number of accounts in which to perform this operation at one time.\n" }, "maxConcurrentPercentage": { "type": "integer", "description": "Maximum percentage of accounts in which to perform this operation at one time.\n" }, "regionConcurrencyType": { "type": "string", "description": "Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are `SEQUENTIAL` and `PARALLEL`.\n" }, "regionOrders": { "type": "array", "items": { "type": "string" }, "description": "Order of the regions where you want to perform the stack operation.\n" } }, "type": "object" }, "aws:cloudformation/StackInstancesStackInstanceSummary:StackInstancesStackInstanceSummary": { "properties": { "accountId": { "type": "string", "description": "Account ID in which the instance is deployed.\n" }, "detailedStatus": { "type": "string", "description": "Detailed status of the stack instance. Values include `PENDING`, `RUNNING`, `SUCCEEDED`, `FAILED`, `CANCELLED`, `INOPERABLE`, `SKIPPED_SUSPENDED_ACCOUNT`, `FAILED_IMPORT`.\n" }, "driftStatus": { "type": "string", "description": "Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include `DRIFTED`, `IN_SYNC`, `UNKNOWN`, `NOT_CHECKED`.\n" }, "organizationalUnitId": { "type": "string", "description": "Organization root ID or organizational unit (OU) IDs that you specified for `deployment_targets`.\n" }, "region": { "type": "string", "description": "Region that the stack instance is associated with.\n" }, "stackId": { "type": "string", "description": "ID of the stack instance.\n" }, "stackSetId": { "type": "string", "description": "Name or unique ID of the stack set that the stack instance is associated with.\n" }, "status": { "type": "string", "description": "Status of the stack instance, in terms of its synchronization with its associated stack set. Values include `CURRENT`, `OUTDATED`, `INOPERABLE`.\n" }, "statusReason": { "type": "string", "description": "Explanation for the specific status code assigned to this stack instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "detailedStatus", "driftStatus", "organizationalUnitId", "region", "stackId", "stackSetId", "status", "statusReason" ] } } }, "aws:cloudformation/StackSetAutoDeployment:StackSetAutoDeployment": { "properties": { "enabled": { "type": "boolean", "description": "Whether or not auto-deployment is enabled.\n" }, "retainStacksOnAccountRemoval": { "type": "boolean", "description": "Whether or not to retain stacks when the account is removed.\n" } }, "type": "object" }, "aws:cloudformation/StackSetInstanceDeploymentTargets:StackSetInstanceDeploymentTargets": { "properties": { "accountFilterType": { "type": "string", "description": "Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: `INTERSECTION`, `DIFFERENCE`, `UNION`, `NONE`.\n", "willReplaceOnChanges": true }, "accounts": { "type": "array", "items": { "type": "string" }, "description": "List of accounts to deploy stack set updates.\n", "willReplaceOnChanges": true }, "accountsUrl": { "type": "string", "description": "S3 URL of the file containing the list of accounts.\n", "willReplaceOnChanges": true }, "organizationalUnitIds": { "type": "array", "items": { "type": "string" }, "description": "Organization root ID or organizational unit (OU) IDs to which StackSets deploys.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:cloudformation/StackSetInstanceOperationPreferences:StackSetInstanceOperationPreferences": { "properties": { "concurrencyMode": { "type": "string", "description": "Specifies how the concurrency level behaves during the operation execution. Valid values are `STRICT_FAILURE_TOLERANCE` and `SOFT_FAILURE_TOLERANCE`.\n" }, "failureToleranceCount": { "type": "integer", "description": "Number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.\n" }, "failureTolerancePercentage": { "type": "integer", "description": "Percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.\n" }, "maxConcurrentCount": { "type": "integer", "description": "Maximum number of accounts in which to perform this operation at one time.\n" }, "maxConcurrentPercentage": { "type": "integer", "description": "Maximum percentage of accounts in which to perform this operation at one time.\n" }, "regionConcurrencyType": { "type": "string", "description": "Concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time. Valid values are `SEQUENTIAL` and `PARALLEL`.\n" }, "regionOrders": { "type": "array", "items": { "type": "string" }, "description": "Order of the Regions in where you want to perform the stack operation.\n" } }, "type": "object" }, "aws:cloudformation/StackSetInstanceStackInstanceSummary:StackSetInstanceStackInstanceSummary": { "properties": { "accountId": { "type": "string", "description": "Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.\n" }, "organizationalUnitId": { "type": "string", "description": "Organizational unit ID in which the stack is deployed.\n" }, "stackId": { "type": "string", "description": "Stack identifier.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "organizationalUnitId", "stackId" ] } } }, "aws:cloudformation/StackSetManagedExecution:StackSetManagedExecution": { "properties": { "active": { "type": "boolean", "description": "When set to true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order. Default is false.\n" } }, "type": "object" }, "aws:cloudformation/StackSetOperationPreferences:StackSetOperationPreferences": { "properties": { "failureToleranceCount": { "type": "integer", "description": "The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.\n" }, "failureTolerancePercentage": { "type": "integer", "description": "The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.\n" }, "maxConcurrentCount": { "type": "integer", "description": "The maximum number of accounts in which to perform this operation at one time.\n" }, "maxConcurrentPercentage": { "type": "integer", "description": "The maximum percentage of accounts in which to perform this operation at one time.\n" }, "regionConcurrencyType": { "type": "string", "description": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.\n" }, "regionOrders": { "type": "array", "items": { "type": "string" }, "description": "The order of the Regions in where you want to perform the stack operation.\n" } }, "type": "object" }, "aws:cloudformation/getCloudFormationTypeLoggingConfig:getCloudFormationTypeLoggingConfig": { "properties": { "logGroupName": { "type": "string", "description": "Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.\n" }, "logRoleArn": { "type": "string", "description": "ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.\n" } }, "type": "object", "required": [ "logGroupName", "logRoleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOrigin:CachePolicyParametersInCacheKeyAndForwardedToOrigin": { "properties": { "cookiesConfig": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig", "description": "Whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.\n" }, "enableAcceptEncodingBrotli": { "type": "boolean", "description": "Flag determines whether the Accept-Encoding HTTP header is included in the cache key and in requests that CloudFront sends to the origin.\n" }, "enableAcceptEncodingGzip": { "type": "boolean", "description": "Whether the Accept-Encoding HTTP header is included in the cache key and in requests sent to the origin by CloudFront.\n" }, "headersConfig": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig", "description": "Whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.\n" }, "queryStringsConfig": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig", "description": "Whether any URL query strings in viewer requests are included in the cache key. It also automatically includes these query strings in requests that CloudFront sends to the origin. Please refer to the Query String Config for more information.\n" } }, "type": "object", "required": [ "cookiesConfig", "headersConfig", "queryStringsConfig" ] }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig": { "properties": { "cookieBehavior": { "type": "string", "description": "Whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values for `cookie_behavior` are `none`, `whitelist`, `allExcept`, and `all`.\n" }, "cookies": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies:CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies", "description": "Object that contains a list of cookie names. See Items for more information.\n" } }, "type": "object", "required": [ "cookieBehavior" ] }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies:CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names, such as cookies, headers, or query strings.\n" } }, "type": "object" }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig": { "properties": { "headerBehavior": { "type": "string", "description": "Whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values for `header_behavior` are `none` and `whitelist`.\n" }, "headers": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders:CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders", "description": "Object contains a list of header names. See Items for more information.\n" } }, "type": "object" }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders:CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names, such as cookies, headers, or query strings.\n" } }, "type": "object" }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig:CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig": { "properties": { "queryStringBehavior": { "type": "string", "description": "Whether URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values for `query_string_behavior` are `none`, `whitelist`, `allExcept`, and `all`.\n" }, "queryStrings": { "$ref": "#/types/aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings:CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings", "description": "Configuration parameter that contains a list of query string names. See Items for more information.\n" } }, "type": "object", "required": [ "queryStringBehavior" ] }, "aws:cloudfront/CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings:CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names, such as cookies, headers, or query strings.\n" } }, "type": "object" }, "aws:cloudfront/ContinuousDeploymentPolicyStagingDistributionDnsNames:ContinuousDeploymentPolicyStagingDistributionDnsNames": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "A list of CloudFront domain names for the staging distribution.\n" }, "quantity": { "type": "integer", "description": "Number of CloudFront domain names in the staging distribution.\n" } }, "type": "object", "required": [ "quantity" ] }, "aws:cloudfront/ContinuousDeploymentPolicyTrafficConfig:ContinuousDeploymentPolicyTrafficConfig": { "properties": { "singleHeaderConfig": { "$ref": "#/types/aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleHeaderConfig:ContinuousDeploymentPolicyTrafficConfigSingleHeaderConfig", "description": "Determines which HTTP requests are sent to the staging distribution. See `single_header_config`.\n" }, "singleWeightConfig": { "$ref": "#/types/aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleWeightConfig:ContinuousDeploymentPolicyTrafficConfigSingleWeightConfig", "description": "Contains the percentage of traffic to send to the staging distribution. See `single_weight_config`.\n" }, "type": { "type": "string", "description": "Type of traffic configuration. Valid values are `SingleWeight` and `SingleHeader`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleHeaderConfig:ContinuousDeploymentPolicyTrafficConfigSingleHeaderConfig": { "properties": { "header": { "type": "string", "description": "Request header name to send to the staging distribution. The header must contain the prefix `aws-cf-cd-`.\n" }, "value": { "type": "string", "description": "Request header value.\n" } }, "type": "object", "required": [ "header", "value" ] }, "aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleWeightConfig:ContinuousDeploymentPolicyTrafficConfigSingleWeightConfig": { "properties": { "sessionStickinessConfig": { "$ref": "#/types/aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleWeightConfigSessionStickinessConfig:ContinuousDeploymentPolicyTrafficConfigSingleWeightConfigSessionStickinessConfig", "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 the staging distribution, while others are sent to the primary distribution. Define the session duration using TTL values. See `session_stickiness_config`.\n" }, "weight": { "type": "number", "description": "The percentage of traffic to send to a staging distribution, expressed as a decimal number between `0` and `.15`.\n" } }, "type": "object", "required": [ "weight" ] }, "aws:cloudfront/ContinuousDeploymentPolicyTrafficConfigSingleWeightConfigSessionStickinessConfig:ContinuousDeploymentPolicyTrafficConfigSingleWeightConfigSessionStickinessConfig": { "properties": { "idleTtl": { "type": "integer", "description": "The amount of time in seconds after which sessions will cease if no requests are received. Valid values are `300` – `3600` (5–60 minutes). The value must be less than or equal to `maximum_ttl`.\n" }, "maximumTtl": { "type": "integer", "description": "The maximum amount of time in seconds to consider requests from the viewer as being part of the same session. Valid values are `300` – `3600` (5–60 minutes). The value must be greater than or equal to `idle_ttl`.\n" } }, "type": "object", "required": [ "idleTtl", "maximumTtl" ] }, "aws:cloudfront/DistributionCustomErrorResponse:DistributionCustomErrorResponse": { "properties": { "errorCachingMinTtl": { "type": "integer", "description": "Minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.\n" }, "errorCode": { "type": "integer", "description": "4xx or 5xx HTTP status code that you want to customize.\n" }, "responseCode": { "type": "integer", "description": "HTTP status code that you want CloudFront to return with the custom error page to the viewer.\n" }, "responsePagePath": { "type": "string", "description": "Path of the custom error page (for example, `/custom_404.html`).\n" } }, "type": "object", "required": [ "errorCode" ] }, "aws:cloudfront/DistributionDefaultCacheBehavior:DistributionDefaultCacheBehavior": { "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.\n" }, "cachePolicyId": { "type": "string", "description": "Unique identifier of the cache policy that is attached to the cache behavior. If configuring the `default_cache_behavior` either `cache_policy_id` or `forwarded_values` must be set.\n" }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "Controls whether CloudFront caches the response to requests using the specified HTTP methods.\n" }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress content for web requests that include `Accept-Encoding: gzip` in the request header (default: `false`).\n" }, "defaultTtl": { "type": "integer", "description": "Default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an `Cache-Control max-age` or `Expires` header. The TTL defined in Cache Policy overrides this configuration.\n" }, "fieldLevelEncryptionId": { "type": "string", "description": "Field level encryption configuration ID.\n" }, "forwardedValues": { "$ref": "#/types/aws:cloudfront/DistributionDefaultCacheBehaviorForwardedValues:DistributionDefaultCacheBehaviorForwardedValues", "description": "The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers (maximum one).\n" }, "functionAssociations": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionDefaultCacheBehaviorFunctionAssociation:DistributionDefaultCacheBehaviorFunctionAssociation" }, "description": "A config block that triggers a cloudfront function with specific actions (maximum 2).\n" }, "grpcConfig": { "$ref": "#/types/aws:cloudfront/DistributionDefaultCacheBehaviorGrpcConfig:DistributionDefaultCacheBehaviorGrpcConfig", "description": "A config block that sets the grpc config.\n" }, "lambdaFunctionAssociations": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionDefaultCacheBehaviorLambdaFunctionAssociation:DistributionDefaultCacheBehaviorLambdaFunctionAssociation" }, "description": "A config block that triggers a lambda function with specific actions (maximum 4).\n" }, "maxTtl": { "type": "integer", "description": "Maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` headers. The TTL defined in Cache Policy overrides this configuration.\n" }, "minTtl": { "type": "integer", "description": "Minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. Defaults to 0 seconds. The TTL defined in Cache Policy overrides this configuration.\n" }, "originRequestPolicyId": { "type": "string", "description": "Unique identifier of the origin request policy that is attached to the behavior.\n" }, "realtimeLogConfigArn": { "type": "string", "description": "ARN of the real-time log configuration that is attached to this cache behavior.\n" }, "responseHeadersPolicyId": { "type": "string", "description": "Identifier for a response headers policy.\n" }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.\n" }, "targetOriginId": { "type": "string", "description": "Value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.\n" }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "List of nested attributes for active trusted key groups, if the distribution is set up to serve private content with signed URLs.\n" }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "List of nested attributes for active trusted signers, if the distribution is set up to serve private content with signed URLs.\n" }, "viewerProtocolPolicy": { "type": "string", "description": "Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. One of `allow-all`, `https-only`, or `redirect-to-https`.\n" } }, "type": "object", "required": [ "allowedMethods", "cachedMethods", "targetOriginId", "viewerProtocolPolicy" ], "language": { "nodejs": { "requiredOutputs": [ "allowedMethods", "cachedMethods", "defaultTtl", "grpcConfig", "maxTtl", "targetOriginId", "trustedKeyGroups", "trustedSigners", "viewerProtocolPolicy" ] } } }, "aws:cloudfront/DistributionDefaultCacheBehaviorForwardedValues:DistributionDefaultCacheBehaviorForwardedValues": { "properties": { "cookies": { "$ref": "#/types/aws:cloudfront/DistributionDefaultCacheBehaviorForwardedValuesCookies:DistributionDefaultCacheBehaviorForwardedValuesCookies", "description": "The forwarded values cookies that specifies how CloudFront handles cookies (maximum one).\n" }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Headers, if any, that you want CloudFront to vary upon for this cache behavior. Specify `*` to include all headers.\n" }, "queryString": { "type": "boolean", "description": "Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.\n" }, "queryStringCacheKeys": { "type": "array", "items": { "type": "string" }, "description": "When specified, along with a value of `true` for `query_string`, all query strings are forwarded, however only the query string keys listed in this argument are cached. When omitted with a value of `true` for `query_string`, all query string keys are cached.\n" } }, "type": "object", "required": [ "cookies", "queryString" ], "language": { "nodejs": { "requiredOutputs": [ "cookies", "headers", "queryString", "queryStringCacheKeys" ] } } }, "aws:cloudfront/DistributionDefaultCacheBehaviorForwardedValuesCookies:DistributionDefaultCacheBehaviorForwardedValuesCookies": { "properties": { "forward": { "type": "string", "description": "Whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify `all`, `none` or `whitelist`. If `whitelist`, you must include the subsequent `whitelisted_names`.\n" }, "whitelistedNames": { "type": "array", "items": { "type": "string" }, "description": "If you have specified `whitelist` to `forward`, the whitelisted cookies that you want CloudFront to forward to your origin.\n" } }, "type": "object", "required": [ "forward" ], "language": { "nodejs": { "requiredOutputs": [ "forward", "whitelistedNames" ] } } }, "aws:cloudfront/DistributionDefaultCacheBehaviorFunctionAssociation:DistributionDefaultCacheBehaviorFunctionAssociation": { "properties": { "eventType": { "type": "string", "description": "Specific event to trigger this function. Valid values: `viewer-request` or `viewer-response`.\n" }, "functionArn": { "type": "string", "description": "ARN of the CloudFront function.\n" } }, "type": "object", "required": [ "eventType", "functionArn" ] }, "aws:cloudfront/DistributionDefaultCacheBehaviorGrpcConfig:DistributionDefaultCacheBehaviorGrpcConfig": { "properties": { "enabled": { "type": "boolean", "description": "`true` if any of the AWS accounts listed as trusted signers have active CloudFront key pairs\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:cloudfront/DistributionDefaultCacheBehaviorLambdaFunctionAssociation:DistributionDefaultCacheBehaviorLambdaFunctionAssociation": { "properties": { "eventType": { "type": "string", "description": "Specific event to trigger this function. Valid values: `viewer-request`, `origin-request`, `viewer-response`, `origin-response`.\n" }, "includeBody": { "type": "boolean", "description": "When set to true it exposes the request body to the lambda function. Defaults to false. Valid values: `true`, `false`.\n" }, "lambdaArn": { "type": "string", "description": "ARN of the Lambda function.\n" } }, "type": "object", "required": [ "eventType", "lambdaArn" ] }, "aws:cloudfront/DistributionLoggingConfig:DistributionLoggingConfig": { "properties": { "bucket": { "type": "string", "description": "Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com`. The bucket must have correct ACL attached with \"FULL_CONTROL\" permission for \"awslogsdelivery\" account (Canonical ID: \"c4c1ede66af53448b93c283ce9448c4ba468c9432aa01d700d3878632f77d2d0\") for log transfer to work.\n" }, "includeCookies": { "type": "boolean", "description": "Whether to include cookies in access logs (default: `false`).\n" }, "prefix": { "type": "string", "description": "Prefix to the access log filenames for this distribution, for example, `myprefix/`.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:cloudfront/DistributionOrderedCacheBehavior:DistributionOrderedCacheBehavior": { "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.\n" }, "cachePolicyId": { "type": "string", "description": "Unique identifier of the cache policy that is attached to the cache behavior. If configuring the `default_cache_behavior` either `cache_policy_id` or `forwarded_values` must be set.\n" }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "Controls whether CloudFront caches the response to requests using the specified HTTP methods.\n" }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress content for web requests that include `Accept-Encoding: gzip` in the request header (default: `false`).\n" }, "defaultTtl": { "type": "integer", "description": "Default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an `Cache-Control max-age` or `Expires` header. The TTL defined in Cache Policy overrides this configuration.\n" }, "fieldLevelEncryptionId": { "type": "string", "description": "Field level encryption configuration ID.\n" }, "forwardedValues": { "$ref": "#/types/aws:cloudfront/DistributionOrderedCacheBehaviorForwardedValues:DistributionOrderedCacheBehaviorForwardedValues", "description": "The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers (maximum one).\n" }, "functionAssociations": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionOrderedCacheBehaviorFunctionAssociation:DistributionOrderedCacheBehaviorFunctionAssociation" }, "description": "A config block that triggers a cloudfront function with specific actions (maximum 2).\n" }, "grpcConfig": { "$ref": "#/types/aws:cloudfront/DistributionOrderedCacheBehaviorGrpcConfig:DistributionOrderedCacheBehaviorGrpcConfig", "description": "A config block that sets the grpc config.\n" }, "lambdaFunctionAssociations": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionOrderedCacheBehaviorLambdaFunctionAssociation:DistributionOrderedCacheBehaviorLambdaFunctionAssociation" }, "description": "A config block that triggers a lambda function with specific actions (maximum 4).\n" }, "maxTtl": { "type": "integer", "description": "Maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` headers. The TTL defined in Cache Policy overrides this configuration.\n" }, "minTtl": { "type": "integer", "description": "Minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. Defaults to 0 seconds. The TTL defined in Cache Policy overrides this configuration.\n" }, "originRequestPolicyId": { "type": "string", "description": "Unique identifier of the origin request policy that is attached to the behavior.\n" }, "pathPattern": { "type": "string", "description": "Pattern (for example, `images/*.jpg`) that specifies which requests you want this cache behavior to apply to.\n" }, "realtimeLogConfigArn": { "type": "string", "description": "ARN of the real-time log configuration that is attached to this cache behavior.\n" }, "responseHeadersPolicyId": { "type": "string", "description": "Identifier for a response headers policy.\n" }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.\n" }, "targetOriginId": { "type": "string", "description": "Value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.\n" }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "List of nested attributes for active trusted key groups, if the distribution is set up to serve private content with signed URLs.\n" }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "List of nested attributes for active trusted signers, if the distribution is set up to serve private content with signed URLs.\n" }, "viewerProtocolPolicy": { "type": "string", "description": "Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. One of `allow-all`, `https-only`, or `redirect-to-https`.\n" } }, "type": "object", "required": [ "allowedMethods", "cachedMethods", "pathPattern", "targetOriginId", "viewerProtocolPolicy" ], "language": { "nodejs": { "requiredOutputs": [ "allowedMethods", "cachedMethods", "defaultTtl", "grpcConfig", "maxTtl", "pathPattern", "targetOriginId", "viewerProtocolPolicy" ] } } }, "aws:cloudfront/DistributionOrderedCacheBehaviorForwardedValues:DistributionOrderedCacheBehaviorForwardedValues": { "properties": { "cookies": { "$ref": "#/types/aws:cloudfront/DistributionOrderedCacheBehaviorForwardedValuesCookies:DistributionOrderedCacheBehaviorForwardedValuesCookies", "description": "The forwarded values cookies that specifies how CloudFront handles cookies (maximum one).\n" }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Headers, if any, that you want CloudFront to vary upon for this cache behavior. Specify `*` to include all headers.\n" }, "queryString": { "type": "boolean", "description": "Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.\n" }, "queryStringCacheKeys": { "type": "array", "items": { "type": "string" }, "description": "When specified, along with a value of `true` for `query_string`, all query strings are forwarded, however only the query string keys listed in this argument are cached. When omitted with a value of `true` for `query_string`, all query string keys are cached.\n" } }, "type": "object", "required": [ "cookies", "queryString" ], "language": { "nodejs": { "requiredOutputs": [ "cookies", "headers", "queryString", "queryStringCacheKeys" ] } } }, "aws:cloudfront/DistributionOrderedCacheBehaviorForwardedValuesCookies:DistributionOrderedCacheBehaviorForwardedValuesCookies": { "properties": { "forward": { "type": "string", "description": "Whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify `all`, `none` or `whitelist`. If `whitelist`, you must include the subsequent `whitelisted_names`.\n" }, "whitelistedNames": { "type": "array", "items": { "type": "string" }, "description": "If you have specified `whitelist` to `forward`, the whitelisted cookies that you want CloudFront to forward to your origin.\n" } }, "type": "object", "required": [ "forward" ] }, "aws:cloudfront/DistributionOrderedCacheBehaviorFunctionAssociation:DistributionOrderedCacheBehaviorFunctionAssociation": { "properties": { "eventType": { "type": "string", "description": "Specific event to trigger this function. Valid values: `viewer-request` or `viewer-response`.\n" }, "functionArn": { "type": "string", "description": "ARN of the CloudFront function.\n" } }, "type": "object", "required": [ "eventType", "functionArn" ] }, "aws:cloudfront/DistributionOrderedCacheBehaviorGrpcConfig:DistributionOrderedCacheBehaviorGrpcConfig": { "properties": { "enabled": { "type": "boolean", "description": "`true` if any of the AWS accounts listed as trusted signers have active CloudFront key pairs\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:cloudfront/DistributionOrderedCacheBehaviorLambdaFunctionAssociation:DistributionOrderedCacheBehaviorLambdaFunctionAssociation": { "properties": { "eventType": { "type": "string", "description": "Specific event to trigger this function. Valid values: `viewer-request`, `origin-request`, `viewer-response`, `origin-response`.\n" }, "includeBody": { "type": "boolean", "description": "When set to true it exposes the request body to the lambda function. Defaults to false. Valid values: `true`, `false`.\n" }, "lambdaArn": { "type": "string", "description": "ARN of the Lambda function.\n" } }, "type": "object", "required": [ "eventType", "lambdaArn" ] }, "aws:cloudfront/DistributionOrigin:DistributionOrigin": { "properties": { "connectionAttempts": { "type": "integer", "description": "Number of times that CloudFront attempts to connect to the origin. Must be between 1-3. Defaults to 3.\n" }, "connectionTimeout": { "type": "integer", "description": "Number of seconds that CloudFront waits when trying to establish a connection to the origin. Must be between 1-10. Defaults to 10.\n" }, "customHeaders": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionOriginCustomHeader:DistributionOriginCustomHeader" }, "description": "One or more sub-resources with `name` and `value` parameters that specify header data that will be sent to the origin (multiples allowed).\n" }, "customOriginConfig": { "$ref": "#/types/aws:cloudfront/DistributionOriginCustomOriginConfig:DistributionOriginCustomOriginConfig", "description": "The CloudFront custom origin configuration information. If an S3 origin is required, use `origin_access_control_id` or `s3_origin_config` instead.\n" }, "domainName": { "type": "string", "description": "Domain name corresponding to the distribution. For example: `d604721fxaaqy9.cloudfront.net`.\n" }, "originAccessControlId": { "type": "string", "description": "Unique identifier of a [CloudFront origin access control][8] for this origin.\n" }, "originId": { "type": "string" }, "originPath": { "type": "string", "description": "Optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.\n" }, "originShield": { "$ref": "#/types/aws:cloudfront/DistributionOriginOriginShield:DistributionOriginOriginShield", "description": "CloudFront Origin Shield configuration information. 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.\n" }, "s3OriginConfig": { "$ref": "#/types/aws:cloudfront/DistributionOriginS3OriginConfig:DistributionOriginS3OriginConfig", "description": "CloudFront S3 origin configuration information. If a custom origin is required, use `custom_origin_config` instead.\n" }, "vpcOriginConfig": { "$ref": "#/types/aws:cloudfront/DistributionOriginVpcOriginConfig:DistributionOriginVpcOriginConfig", "description": "The VPC origin configuration.\n" } }, "type": "object", "required": [ "domainName", "originId" ] }, "aws:cloudfront/DistributionOriginCustomHeader:DistributionOriginCustomHeader": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "name", "value" ] }, "aws:cloudfront/DistributionOriginCustomOriginConfig:DistributionOriginCustomOriginConfig": { "properties": { "httpPort": { "type": "integer", "description": "HTTP port the custom origin listens on.\n" }, "httpsPort": { "type": "integer", "description": "HTTPS port the custom origin listens on.\n" }, "originKeepaliveTimeout": { "type": "integer" }, "originProtocolPolicy": { "type": "string", "description": "Origin protocol policy to apply to your origin. One of `http-only`, `https-only`, or `match-viewer`.\n" }, "originReadTimeout": { "type": "integer" }, "originSslProtocols": { "type": "array", "items": { "type": "string" }, "description": "List of SSL/TLS protocols that CloudFront can use when connecting to your origin over HTTPS. Valid values: `SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`. For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the Amazon CloudFront Developer Guide.\n" } }, "type": "object", "required": [ "httpPort", "httpsPort", "originProtocolPolicy", "originSslProtocols" ] }, "aws:cloudfront/DistributionOriginGroup:DistributionOriginGroup": { "properties": { "failoverCriteria": { "$ref": "#/types/aws:cloudfront/DistributionOriginGroupFailoverCriteria:DistributionOriginGroupFailoverCriteria", "description": "The failover criteria for when to failover to the secondary origin.\n" }, "members": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionOriginGroupMember:DistributionOriginGroupMember" }, "description": "Ordered member configuration blocks assigned to the origin group, where the first member is the primary origin. You must specify two members.\n" }, "originId": { "type": "string" } }, "type": "object", "required": [ "failoverCriteria", "members", "originId" ] }, "aws:cloudfront/DistributionOriginGroupFailoverCriteria:DistributionOriginGroupFailoverCriteria": { "properties": { "statusCodes": { "type": "array", "items": { "type": "integer" }, "description": "List of HTTP status codes for the origin group.\n" } }, "type": "object", "required": [ "statusCodes" ] }, "aws:cloudfront/DistributionOriginGroupMember:DistributionOriginGroupMember": { "properties": { "originId": { "type": "string" } }, "type": "object", "required": [ "originId" ] }, "aws:cloudfront/DistributionOriginOriginShield:DistributionOriginOriginShield": { "properties": { "enabled": { "type": "boolean", "description": "`true` if any of the AWS accounts listed as trusted signers have active CloudFront key pairs\n" }, "originShieldRegion": { "type": "string", "description": "AWS Region for Origin Shield. 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" } }, "type": "object", "required": [ "enabled" ] }, "aws:cloudfront/DistributionOriginS3OriginConfig:DistributionOriginS3OriginConfig": { "properties": { "originAccessIdentity": { "type": "string", "description": "The CloudFront origin access identity to associate with the origin.\n" } }, "type": "object", "required": [ "originAccessIdentity" ] }, "aws:cloudfront/DistributionOriginVpcOriginConfig:DistributionOriginVpcOriginConfig": { "properties": { "originKeepaliveTimeout": { "type": "integer" }, "originReadTimeout": { "type": "integer" }, "vpcOriginId": { "type": "string", "description": "The VPC origin ID.\n" } }, "type": "object", "required": [ "vpcOriginId" ] }, "aws:cloudfront/DistributionRestrictions:DistributionRestrictions": { "properties": { "geoRestriction": { "$ref": "#/types/aws:cloudfront/DistributionRestrictionsGeoRestriction:DistributionRestrictionsGeoRestriction" } }, "type": "object", "required": [ "geoRestriction" ] }, "aws:cloudfront/DistributionRestrictionsGeoRestriction:DistributionRestrictionsGeoRestriction": { "properties": { "locations": { "type": "array", "items": { "type": "string" }, "description": "[ISO 3166-1-alpha-2 codes][4] for which you want CloudFront either to distribute your content (`whitelist`) or not distribute your content (`blacklist`). If the type is specified as `none` an empty array can be used.\n" }, "restrictionType": { "type": "string", "description": "Method that you want to use to restrict distribution of your content by country: `none`, `whitelist`, or `blacklist`.\n" } }, "type": "object", "required": [ "restrictionType" ], "language": { "nodejs": { "requiredOutputs": [ "locations", "restrictionType" ] } } }, "aws:cloudfront/DistributionTrustedKeyGroup:DistributionTrustedKeyGroup": { "properties": { "enabled": { "type": "boolean", "description": "`true` if any of the AWS accounts listed as trusted signers have active CloudFront key pairs\n" }, "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionTrustedKeyGroupItem:DistributionTrustedKeyGroupItem" }, "description": "List of nested attributes for each trusted signer\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "items" ] } } }, "aws:cloudfront/DistributionTrustedKeyGroupItem:DistributionTrustedKeyGroupItem": { "properties": { "keyGroupId": { "type": "string", "description": "ID of the key group that contains the public keys.\n" }, "keyPairIds": { "type": "array", "items": { "type": "string" }, "description": "Set of active CloudFront key pairs associated with the signer account\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keyGroupId", "keyPairIds" ] } } }, "aws:cloudfront/DistributionTrustedSigner:DistributionTrustedSigner": { "properties": { "enabled": { "type": "boolean", "description": "`true` if any of the AWS accounts listed as trusted signers have active CloudFront key pairs\n" }, "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/DistributionTrustedSignerItem:DistributionTrustedSignerItem" }, "description": "List of nested attributes for each trusted signer\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "items" ] } } }, "aws:cloudfront/DistributionTrustedSignerItem:DistributionTrustedSignerItem": { "properties": { "awsAccountNumber": { "type": "string", "description": "AWS account ID or `self`\n" }, "keyPairIds": { "type": "array", "items": { "type": "string" }, "description": "Set of active CloudFront key pairs associated with the signer account\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "awsAccountNumber", "keyPairIds" ] } } }, "aws:cloudfront/DistributionViewerCertificate:DistributionViewerCertificate": { "properties": { "acmCertificateArn": { "type": "string", "description": "ARN of the [AWS Certificate Manager](https://aws.amazon.com/certificate-manager/) certificate that you wish to use with this distribution. Specify this, `cloudfront_default_certificate`, or `iam_certificate_id`. The ACM certificate must be in US-EAST-1.\n" }, "cloudfrontDefaultCertificate": { "type": "boolean", "description": "`true` if you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name for your distribution. Specify this, `acm_certificate_arn`, or `iam_certificate_id`.\n" }, "iamCertificateId": { "type": "string", "description": "IAM certificate identifier of the custom viewer certificate for this distribution if you are using a custom domain. Specify this, `acm_certificate_arn`, or `cloudfront_default_certificate`.\n" }, "minimumProtocolVersion": { "type": "string", "description": "Minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections. Can only be set if `cloudfront_default_certificate = false`. See all possible values in [this](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html) table under \"Security policy.\" Some examples include: `TLSv1.2_2019` and `TLSv1.2_2021`. Default: `TLSv1`. **NOTE**: If you are using a custom certificate (specified with `acm_certificate_arn` or `iam_certificate_id`), and have specified `sni-only` in `ssl_support_method`, `TLSv1` or later must be specified. If you have specified `vip` in `ssl_support_method`, only `SSLv3` or `TLSv1` can be specified. If you have specified `cloudfront_default_certificate`, `TLSv1` must be specified.\n" }, "sslSupportMethod": { "type": "string", "description": "How you want CloudFront to serve HTTPS requests. One of `vip`, `sni-only`, or `static-ip`. Required if you specify `acm_certificate_arn` or `iam_certificate_id`. **NOTE:** `vip` causes CloudFront to use a dedicated IP address and may incur extra charges.\n" } }, "type": "object" }, "aws:cloudfront/FieldLevelEncryptionConfigContentTypeProfileConfig:FieldLevelEncryptionConfigContentTypeProfileConfig": { "properties": { "contentTypeProfiles": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfiles:FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfiles", "description": "Object that contains an attribute `items` that contains the list of configurations for a field-level encryption content type-profile. See Content Type Profile.\n" }, "forwardWhenContentTypeIsUnknown": { "type": "boolean", "description": "specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.\n" } }, "type": "object", "required": [ "contentTypeProfiles", "forwardWhenContentTypeIsUnknown" ] }, "aws:cloudfront/FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfiles:FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfiles": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItem:FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItem" } } }, "type": "object", "required": [ "items" ] }, "aws:cloudfront/FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItem:FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItem": { "properties": { "contentType": { "type": "string", "description": "he content type for a field-level encryption content type-profile mapping. Valid value is `application/x-www-form-urlencoded`.\n" }, "format": { "type": "string", "description": "The format for a field-level encryption content type-profile mapping. Valid value is `URLEncoded`.\n" }, "profileId": { "type": "string" } }, "type": "object", "required": [ "contentType", "format" ] }, "aws:cloudfront/FieldLevelEncryptionConfigQueryArgProfileConfig:FieldLevelEncryptionConfigQueryArgProfileConfig": { "properties": { "forwardWhenQueryArgProfileIsUnknown": { "type": "boolean", "description": "Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.\n" }, "queryArgProfiles": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfiles:FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfiles", "description": "Object that contains an attribute `items` that contains the list ofrofiles specified for query argument-profile mapping for field-level encryption. see Query Arg Profile.\n" } }, "type": "object", "required": [ "forwardWhenQueryArgProfileIsUnknown" ] }, "aws:cloudfront/FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfiles:FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfiles": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItem:FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItem" } } }, "type": "object" }, "aws:cloudfront/FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItem:FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItem": { "properties": { "profileId": { "type": "string" }, "queryArg": { "type": "string", "description": "Query argument for field-level encryption query argument-profile mapping.\n" } }, "type": "object", "required": [ "profileId", "queryArg" ] }, "aws:cloudfront/FieldLevelEncryptionProfileEncryptionEntities:FieldLevelEncryptionProfileEncryptionEntities": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionProfileEncryptionEntitiesItem:FieldLevelEncryptionProfileEncryptionEntitiesItem" } } }, "type": "object" }, "aws:cloudfront/FieldLevelEncryptionProfileEncryptionEntitiesItem:FieldLevelEncryptionProfileEncryptionEntitiesItem": { "properties": { "fieldPatterns": { "$ref": "#/types/aws:cloudfront/FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatterns:FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatterns", "description": "Object that contains an attribute `items` that contains the list of field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted.\n" }, "providerId": { "type": "string", "description": "The provider associated with the public key being used for encryption.\n" }, "publicKeyId": { "type": "string", "description": "The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.\n" } }, "type": "object", "required": [ "fieldPatterns", "providerId", "publicKeyId" ] }, "aws:cloudfront/FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatterns:FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatterns": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/KeyValueStoreTimeouts:KeyValueStoreTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:cloudfront/MonitoringSubscriptionMonitoringSubscription:MonitoringSubscriptionMonitoringSubscription": { "properties": { "realtimeMetricsSubscriptionConfig": { "$ref": "#/types/aws:cloudfront/MonitoringSubscriptionMonitoringSubscriptionRealtimeMetricsSubscriptionConfig:MonitoringSubscriptionMonitoringSubscriptionRealtimeMetricsSubscriptionConfig", "description": "A subscription configuration for additional CloudWatch metrics. See below.\n" } }, "type": "object", "required": [ "realtimeMetricsSubscriptionConfig" ] }, "aws:cloudfront/MonitoringSubscriptionMonitoringSubscriptionRealtimeMetricsSubscriptionConfig:MonitoringSubscriptionMonitoringSubscriptionRealtimeMetricsSubscriptionConfig": { "properties": { "realtimeMetricsSubscriptionStatus": { "type": "string", "description": "A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution. Valid values are `Enabled` and `Disabled`. See below.\n" } }, "type": "object", "required": [ "realtimeMetricsSubscriptionStatus" ] }, "aws:cloudfront/OriginRequestPolicyCookiesConfig:OriginRequestPolicyCookiesConfig": { "properties": { "cookieBehavior": { "type": "string" }, "cookies": { "$ref": "#/types/aws:cloudfront/OriginRequestPolicyCookiesConfigCookies:OriginRequestPolicyCookiesConfigCookies" } }, "type": "object", "required": [ "cookieBehavior" ] }, "aws:cloudfront/OriginRequestPolicyCookiesConfigCookies:OriginRequestPolicyCookiesConfigCookies": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/OriginRequestPolicyHeadersConfig:OriginRequestPolicyHeadersConfig": { "properties": { "headerBehavior": { "type": "string" }, "headers": { "$ref": "#/types/aws:cloudfront/OriginRequestPolicyHeadersConfigHeaders:OriginRequestPolicyHeadersConfigHeaders" } }, "type": "object" }, "aws:cloudfront/OriginRequestPolicyHeadersConfigHeaders:OriginRequestPolicyHeadersConfigHeaders": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/OriginRequestPolicyQueryStringsConfig:OriginRequestPolicyQueryStringsConfig": { "properties": { "queryStringBehavior": { "type": "string" }, "queryStrings": { "$ref": "#/types/aws:cloudfront/OriginRequestPolicyQueryStringsConfigQueryStrings:OriginRequestPolicyQueryStringsConfigQueryStrings" } }, "type": "object", "required": [ "queryStringBehavior" ] }, "aws:cloudfront/OriginRequestPolicyQueryStringsConfigQueryStrings:OriginRequestPolicyQueryStringsConfigQueryStrings": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/RealtimeLogConfigEndpoint:RealtimeLogConfigEndpoint": { "properties": { "kinesisStreamConfig": { "$ref": "#/types/aws:cloudfront/RealtimeLogConfigEndpointKinesisStreamConfig:RealtimeLogConfigEndpointKinesisStreamConfig", "description": "The Amazon Kinesis data stream configuration.\n" }, "streamType": { "type": "string", "description": "The type of data stream where real-time log data is sent. The only valid value is `Kinesis`.\n" } }, "type": "object", "required": [ "kinesisStreamConfig", "streamType" ] }, "aws:cloudfront/RealtimeLogConfigEndpointKinesisStreamConfig:RealtimeLogConfigEndpointKinesisStreamConfig": { "properties": { "roleArn": { "type": "string", "description": "The ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream.\nSee the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) for more information.\n" }, "streamArn": { "type": "string", "description": "The ARN of the Kinesis data stream.\n" } }, "type": "object", "required": [ "roleArn", "streamArn" ] }, "aws:cloudfront/ResponseHeadersPolicyCorsConfig:ResponseHeadersPolicyCorsConfig": { "properties": { "accessControlAllowCredentials": { "type": "boolean", "description": "A Boolean value that CloudFront uses as the value for the `Access-Control-Allow-Credentials` HTTP response header.\n" }, "accessControlAllowHeaders": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowHeaders:ResponseHeadersPolicyCorsConfigAccessControlAllowHeaders", "description": "Object that contains an attribute `items` that contains a list of HTTP header names that CloudFront includes as values for the `Access-Control-Allow-Headers` HTTP response header.\n" }, "accessControlAllowMethods": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowMethods:ResponseHeadersPolicyCorsConfigAccessControlAllowMethods", "description": "Object that contains an attribute `items` that contains a list of HTTP methods that CloudFront includes as values for the `Access-Control-Allow-Methods` HTTP response header. Valid values: `GET` | `POST` | `OPTIONS` | `PUT` | `DELETE` | `HEAD` | `ALL`\n" }, "accessControlAllowOrigins": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowOrigins:ResponseHeadersPolicyCorsConfigAccessControlAllowOrigins", "description": "Object that contains an attribute `items` that contains a list of origins that CloudFront can use as the value for the `Access-Control-Allow-Origin` HTTP response header.\n" }, "accessControlExposeHeaders": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlExposeHeaders:ResponseHeadersPolicyCorsConfigAccessControlExposeHeaders", "description": "Object that contains an attribute `items` that contains a list of HTTP headers that CloudFront includes as values for the `Access-Control-Expose-Headers` HTTP response header.\n" }, "accessControlMaxAgeSec": { "type": "integer", "description": "A number that CloudFront uses as the value for the `Access-Control-Max-Age` HTTP response header.\n" }, "originOverride": { "type": "boolean", "description": "A Boolean value that determines how CloudFront behaves for the HTTP response header.\n" } }, "type": "object", "required": [ "accessControlAllowCredentials", "accessControlAllowHeaders", "accessControlAllowMethods", "accessControlAllowOrigins", "originOverride" ] }, "aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowHeaders:ResponseHeadersPolicyCorsConfigAccessControlAllowHeaders": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowMethods:ResponseHeadersPolicyCorsConfigAccessControlAllowMethods": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlAllowOrigins:ResponseHeadersPolicyCorsConfigAccessControlAllowOrigins": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyCorsConfigAccessControlExposeHeaders:ResponseHeadersPolicyCorsConfigAccessControlExposeHeaders": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyCustomHeadersConfig:ResponseHeadersPolicyCustomHeadersConfig": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyCustomHeadersConfigItem:ResponseHeadersPolicyCustomHeadersConfigItem" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyCustomHeadersConfigItem:ResponseHeadersPolicyCustomHeadersConfigItem": { "properties": { "header": { "type": "string" }, "override": { "type": "boolean" }, "value": { "type": "string", "description": "The value for the HTTP response header.\n" } }, "type": "object", "required": [ "header", "override", "value" ] }, "aws:cloudfront/ResponseHeadersPolicyRemoveHeadersConfig:ResponseHeadersPolicyRemoveHeadersConfig": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicyRemoveHeadersConfigItem:ResponseHeadersPolicyRemoveHeadersConfigItem" } } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicyRemoveHeadersConfigItem:ResponseHeadersPolicyRemoveHeadersConfigItem": { "properties": { "header": { "type": "string" } }, "type": "object", "required": [ "header" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfig:ResponseHeadersPolicySecurityHeadersConfig": { "properties": { "contentSecurityPolicy": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy:ResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy", "description": "The policy directives and their values that CloudFront includes as values for the `Content-Security-Policy` HTTP response header. See Content Security Policy for more information.\n" }, "contentTypeOptions": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigContentTypeOptions:ResponseHeadersPolicySecurityHeadersConfigContentTypeOptions", "description": "Determines whether CloudFront includes the `X-Content-Type-Options` HTTP response header with its value set to `nosniff`. See Content Type Options for more information.\n" }, "frameOptions": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigFrameOptions:ResponseHeadersPolicySecurityHeadersConfigFrameOptions", "description": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header’s value. See Frame Options for more information.\n" }, "referrerPolicy": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigReferrerPolicy:ResponseHeadersPolicySecurityHeadersConfigReferrerPolicy", "description": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header’s value. See Referrer Policy for more information.\n" }, "strictTransportSecurity": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity:ResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity", "description": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header’s value. See Strict Transport Security for more information.\n" }, "xssProtection": { "$ref": "#/types/aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigXssProtection:ResponseHeadersPolicySecurityHeadersConfigXssProtection", "description": "Determine whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header’s value. See XSS Protection for more information.\n" } }, "type": "object" }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy:ResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy": { "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" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the `Content-Security-Policy` HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "contentSecurityPolicy", "override" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigContentTypeOptions:ResponseHeadersPolicySecurityHeadersConfigContentTypeOptions": { "properties": { "override": { "type": "boolean", "description": "Whether CloudFront overrides the `X-Content-Type-Options` HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "override" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigFrameOptions:ResponseHeadersPolicySecurityHeadersConfigFrameOptions": { "properties": { "frameOption": { "type": "string", "description": "The value of the `X-Frame-Options` HTTP response header. Valid values: `DENY` | `SAMEORIGIN`\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the `X-Frame-Options` HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "frameOption", "override" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigReferrerPolicy:ResponseHeadersPolicySecurityHeadersConfigReferrerPolicy": { "properties": { "override": { "type": "boolean", "description": "Whether CloudFront overrides the `Referrer-Policy` HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "referrerPolicy": { "type": "string", "description": "The value of the `Referrer-Policy` HTTP response header. Valid Values: `no-referrer` | `no-referrer-when-downgrade` | `origin` | `origin-when-cross-origin` | `same-origin` | `strict-origin` | `strict-origin-when-cross-origin` | `unsafe-url`\n" } }, "type": "object", "required": [ "override", "referrerPolicy" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity:ResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity": { "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.\n" }, "includeSubdomains": { "type": "boolean", "description": "Whether CloudFront includes the `includeSubDomains` directive in the `Strict-Transport-Security` HTTP response header.\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the `Strict-Transport-Security` HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "preload": { "type": "boolean", "description": "Whether CloudFront includes the `preload` directive in the `Strict-Transport-Security` HTTP response header.\n" } }, "type": "object", "required": [ "accessControlMaxAgeSec", "override" ] }, "aws:cloudfront/ResponseHeadersPolicySecurityHeadersConfigXssProtection:ResponseHeadersPolicySecurityHeadersConfigXssProtection": { "properties": { "modeBlock": { "type": "boolean", "description": "Whether CloudFront includes the `mode=block` directive in the `X-XSS-Protection` header.\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the `X-XSS-Protection` HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "protection": { "type": "boolean", "description": "A Boolean value 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" }, "reportUri": { "type": "string", "description": "A reporting URI, which CloudFront uses as the value of the report directive in the `X-XSS-Protection` header. You cannot specify a `report_uri` when `mode_block` is `true`.\n" } }, "type": "object", "required": [ "override", "protection" ] }, "aws:cloudfront/ResponseHeadersPolicyServerTimingHeadersConfig:ResponseHeadersPolicyServerTimingHeadersConfig": { "properties": { "enabled": { "type": "boolean", "description": "A 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.\n" }, "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. Valid range: Minimum value of 0.0. Maximum value of 100.0.\n" } }, "type": "object", "required": [ "enabled", "samplingRate" ] }, "aws:cloudfront/VpcOriginTimeouts:VpcOriginTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:cloudfront/VpcOriginVpcOriginEndpointConfig:VpcOriginVpcOriginEndpointConfig": { "properties": { "arn": { "type": "string", "description": "The VPC origin ARN.\n" }, "httpPort": { "type": "integer", "description": "The HTTP port for the CloudFront VPC origin endpoint configuration.\n" }, "httpsPort": { "type": "integer", "description": "The HTTPS port for the CloudFront VPC origin endpoint configuration.\n" }, "name": { "type": "string", "description": "The name of the CloudFront VPC origin endpoint configuration.\n" }, "originProtocolPolicy": { "type": "string", "description": "The origin protocol policy for the CloudFront VPC origin endpoint configuration.\n" }, "originSslProtocols": { "$ref": "#/types/aws:cloudfront/VpcOriginVpcOriginEndpointConfigOriginSslProtocols:VpcOriginVpcOriginEndpointConfigOriginSslProtocols", "description": "A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.\n" } }, "type": "object", "required": [ "arn", "httpPort", "httpsPort", "name", "originProtocolPolicy" ] }, "aws:cloudfront/VpcOriginVpcOriginEndpointConfigOriginSslProtocols:VpcOriginVpcOriginEndpointConfigOriginSslProtocols": { "properties": { "items": { "type": "array", "items": { "type": "string" } }, "quantity": { "type": "integer" } }, "type": "object", "required": [ "items", "quantity" ] }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOrigin:getCachePolicyParametersInCacheKeyAndForwardedToOrigin": { "properties": { "cookiesConfigs": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig" }, "description": "Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.\n" }, "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" }, "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" }, "headersConfigs": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig" }, "description": "Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.\n" }, "queryStringsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig" }, "description": "Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.\n" } }, "type": "object", "required": [ "cookiesConfigs", "enableAcceptEncodingBrotli", "enableAcceptEncodingGzip", "headersConfigs", "queryStringsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig": { "properties": { "cookieBehavior": { "type": "string", "description": "Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are `none`, `whitelist`, `allExcept`, `all`.\n" }, "cookies": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookie:getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookie" }, "description": "Object that contains a list of cookie names. See Items for more information.\n" } }, "type": "object", "required": [ "cookieBehavior", "cookies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookie:getCachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookie": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names (`cookies`, `headers`, or `query_strings`).\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig": { "properties": { "headerBehavior": { "type": "string", "description": "Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are `none`, `whitelist`.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeader:getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeader" }, "description": "Object that contains a list of header names. See Items for more information.\n" } }, "type": "object", "required": [ "headerBehavior", "headers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeader:getCachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeader": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names (`cookies`, `headers`, or `query_strings`).\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig:getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig": { "properties": { "queryStringBehavior": { "type": "string", "description": "Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are `none`, `whitelist`, `allExcept`, `all`.\n" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryString:getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryString" }, "description": "Object that contains a list of query string names. See Items for more information.\n" } }, "type": "object", "required": [ "queryStringBehavior", "queryStrings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryString:getCachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryString": { "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of item names (`cookies`, `headers`, or `query_strings`).\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyCookiesConfig:getOriginRequestPolicyCookiesConfig": { "properties": { "cookieBehavior": { "type": "string" }, "cookies": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getOriginRequestPolicyCookiesConfigCookie:getOriginRequestPolicyCookiesConfigCookie" } } }, "type": "object", "required": [ "cookieBehavior", "cookies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyCookiesConfigCookie:getOriginRequestPolicyCookiesConfigCookie": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyHeadersConfig:getOriginRequestPolicyHeadersConfig": { "properties": { "headerBehavior": { "type": "string" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getOriginRequestPolicyHeadersConfigHeader:getOriginRequestPolicyHeadersConfigHeader" } } }, "type": "object", "required": [ "headerBehavior", "headers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyHeadersConfigHeader:getOriginRequestPolicyHeadersConfigHeader": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyQueryStringsConfig:getOriginRequestPolicyQueryStringsConfig": { "properties": { "queryStringBehavior": { "type": "string" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getOriginRequestPolicyQueryStringsConfigQueryString:getOriginRequestPolicyQueryStringsConfigQueryString" } } }, "type": "object", "required": [ "queryStringBehavior", "queryStrings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getOriginRequestPolicyQueryStringsConfigQueryString:getOriginRequestPolicyQueryStringsConfigQueryString": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getRealtimeLogConfigEndpoint:getRealtimeLogConfigEndpoint": { "properties": { "kinesisStreamConfigs": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getRealtimeLogConfigEndpointKinesisStreamConfig:getRealtimeLogConfigEndpointKinesisStreamConfig" }, "description": "(Required) Amazon Kinesis data stream configuration.\n" }, "streamType": { "type": "string", "description": "(Required) Type of data stream where real-time log data is sent. The only valid value is `Kinesis`.\n" } }, "type": "object", "required": [ "kinesisStreamConfigs", "streamType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getRealtimeLogConfigEndpointKinesisStreamConfig:getRealtimeLogConfigEndpointKinesisStreamConfig": { "properties": { "roleArn": { "type": "string", "description": "(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream.\nSee the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) for more information.\n" }, "streamArn": { "type": "string", "description": "(Required) ARN of the Kinesis data stream.\n" } }, "type": "object", "required": [ "roleArn", "streamArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCorsConfig:getResponseHeadersPolicyCorsConfig": { "properties": { "accessControlAllowCredentials": { "type": "boolean", "description": "A Boolean value that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.\n" }, "accessControlAllowHeaders": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowHeader:getResponseHeadersPolicyCorsConfigAccessControlAllowHeader" }, "description": "Object that contains an attribute `items` that contains a list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.\n" }, "accessControlAllowMethods": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowMethod:getResponseHeadersPolicyCorsConfigAccessControlAllowMethod" }, "description": "Object that contains an attribute `items` that contains a list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header. Valid values: `GET` | `POST` | `OPTIONS` | `PUT` | `DELETE` | `HEAD` | `ALL`\n" }, "accessControlAllowOrigins": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowOrigin:getResponseHeadersPolicyCorsConfigAccessControlAllowOrigin" }, "description": "Object that contains an attribute `items` that contains a list of origins that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.\n" }, "accessControlExposeHeaders": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlExposeHeader:getResponseHeadersPolicyCorsConfigAccessControlExposeHeader" }, "description": "Object that contains an attribute `items` that contains a list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.\n" }, "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.\n" }, "originOverride": { "type": "boolean" } }, "type": "object", "required": [ "accessControlAllowCredentials", "accessControlAllowHeaders", "accessControlAllowMethods", "accessControlAllowOrigins", "accessControlExposeHeaders", "accessControlMaxAgeSec", "originOverride" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowHeader:getResponseHeadersPolicyCorsConfigAccessControlAllowHeader": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowMethod:getResponseHeadersPolicyCorsConfigAccessControlAllowMethod": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlAllowOrigin:getResponseHeadersPolicyCorsConfigAccessControlAllowOrigin": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCorsConfigAccessControlExposeHeader:getResponseHeadersPolicyCorsConfigAccessControlExposeHeader": { "properties": { "items": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCustomHeadersConfig:getResponseHeadersPolicyCustomHeadersConfig": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyCustomHeadersConfigItem:getResponseHeadersPolicyCustomHeadersConfigItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyCustomHeadersConfigItem:getResponseHeadersPolicyCustomHeadersConfigItem": { "properties": { "header": { "type": "string", "description": "The HTTP header name.\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "value": { "type": "string", "description": "Value for the HTTP response header.\n" } }, "type": "object", "required": [ "header", "override", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyRemoveHeadersConfig:getResponseHeadersPolicyRemoveHeadersConfig": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicyRemoveHeadersConfigItem:getResponseHeadersPolicyRemoveHeadersConfigItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyRemoveHeadersConfigItem:getResponseHeadersPolicyRemoveHeadersConfigItem": { "properties": { "header": { "type": "string", "description": "The HTTP header name.\n" } }, "type": "object", "required": [ "header" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfig:getResponseHeadersPolicySecurityHeadersConfig": { "properties": { "contentSecurityPolicies": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy:getResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy" }, "description": "The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.\n" }, "contentTypeOptions": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigContentTypeOption:getResponseHeadersPolicySecurityHeadersConfigContentTypeOption" }, "description": "A setting that determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff. See Content Type Options for more information.\n" }, "frameOptions": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigFrameOption:getResponseHeadersPolicySecurityHeadersConfigFrameOption" }, "description": "Setting that determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value. See Frame Options for more information.\n" }, "referrerPolicies": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigReferrerPolicy:getResponseHeadersPolicySecurityHeadersConfigReferrerPolicy" }, "description": "Value of the Referrer-Policy HTTP response header. Valid Values: `no-referrer` | `no-referrer-when-downgrade` | `origin` | `origin-when-cross-origin` | `same-origin` | `strict-origin` | `strict-origin-when-cross-origin` | `unsafe-url`\n" }, "strictTransportSecurities": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity:getResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity" }, "description": "Settings that determine whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value. See Strict Transport Security for more information.\n" }, "xssProtections": { "type": "array", "items": { "$ref": "#/types/aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigXssProtection:getResponseHeadersPolicySecurityHeadersConfigXssProtection" }, "description": "Settings that determine whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value. See XSS Protection for more information.\n" } }, "type": "object", "required": [ "contentSecurityPolicies", "contentTypeOptions", "frameOptions", "referrerPolicies", "strictTransportSecurities", "xssProtections" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy:getResponseHeadersPolicySecurityHeadersConfigContentSecurityPolicy": { "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" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "contentSecurityPolicy", "override" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigContentTypeOption:getResponseHeadersPolicySecurityHeadersConfigContentTypeOption": { "properties": { "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "override" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigFrameOption:getResponseHeadersPolicySecurityHeadersConfigFrameOption": { "properties": { "frameOption": { "type": "string", "description": "Value of the X-Frame-Options HTTP response header. Valid values: `DENY` | `SAMEORIGIN`\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" } }, "type": "object", "required": [ "frameOption", "override" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigReferrerPolicy:getResponseHeadersPolicySecurityHeadersConfigReferrerPolicy": { "properties": { "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "referrerPolicy": { "type": "string", "description": "Value of the Referrer-Policy HTTP response header. Valid Values: `no-referrer` | `no-referrer-when-downgrade` | `origin` | `origin-when-cross-origin` | `same-origin` | `strict-origin` | `strict-origin-when-cross-origin` | `unsafe-url`\n" } }, "type": "object", "required": [ "override", "referrerPolicy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity:getResponseHeadersPolicySecurityHeadersConfigStrictTransportSecurity": { "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.\n" }, "includeSubdomains": { "type": "boolean", "description": "Whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "preload": { "type": "boolean", "description": "Whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.\n" } }, "type": "object", "required": [ "accessControlMaxAgeSec", "includeSubdomains", "override", "preload" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicySecurityHeadersConfigXssProtection:getResponseHeadersPolicySecurityHeadersConfigXssProtection": { "properties": { "modeBlock": { "type": "boolean", "description": "Whether CloudFront includes the mode=block directive in the X-XSS-Protection header.\n" }, "override": { "type": "boolean", "description": "Whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.\n" }, "protection": { "type": "boolean", "description": "Boolean value 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" }, "reportUri": { "type": "string", "description": "Whether CloudFront sets a reporting URI in the X-XSS-Protection header.\n" } }, "type": "object", "required": [ "modeBlock", "override", "protection", "reportUri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudfront/getResponseHeadersPolicyServerTimingHeadersConfig:getResponseHeadersPolicyServerTimingHeadersConfig": { "properties": { "enabled": { "type": "boolean", "description": "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.\n" }, "samplingRate": { "type": "number", "description": "Number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to.\n" } }, "type": "object", "required": [ "enabled", "samplingRate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudhsmv2/ClusterClusterCertificate:ClusterClusterCertificate": { "properties": { "awsHardwareCertificate": { "type": "string", "description": "The HSM hardware certificate issued (signed) by AWS CloudHSM.\n" }, "clusterCertificate": { "type": "string", "description": "The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.\n" }, "clusterCsr": { "type": "string", "description": "The certificate signing request (CSR). Available only in `UNINITIALIZED` state after an HSM instance is added to the cluster.\n" }, "hsmCertificate": { "type": "string", "description": "The HSM certificate issued (signed) by the HSM hardware.\n" }, "manufacturerHardwareCertificate": { "type": "string", "description": "The HSM hardware certificate issued (signed) by the hardware manufacturer.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "awsHardwareCertificate", "clusterCertificate", "clusterCsr", "hsmCertificate", "manufacturerHardwareCertificate" ] } } }, "aws:cloudhsmv2/getClusterClusterCertificate:getClusterClusterCertificate": { "properties": { "awsHardwareCertificate": { "type": "string", "description": "The HSM hardware certificate issued (signed) by AWS CloudHSM.\n" }, "clusterCertificate": { "type": "string", "description": "The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.\n" }, "clusterCsr": { "type": "string", "description": "The certificate signing request (CSR). Available only in UNINITIALIZED state.\n" }, "hsmCertificate": { "type": "string", "description": "The HSM certificate issued (signed) by the HSM hardware.\n" }, "manufacturerHardwareCertificate": { "type": "string", "description": "The HSM hardware certificate issued (signed) by the hardware manufacturer.\nThe number of available cluster certificates may vary depending on state of the cluster.\n" } }, "type": "object", "required": [ "awsHardwareCertificate", "clusterCertificate", "clusterCsr", "hsmCertificate", "manufacturerHardwareCertificate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudsearch/DomainEndpointOptions:DomainEndpointOptions": { "properties": { "enforceHttps": { "type": "boolean", "description": "Enables or disables the requirement that all requests to the domain arrive over HTTPS.\n" }, "tlsSecurityPolicy": { "type": "string", "description": "The minimum required TLS version. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_DomainEndpointOptions.html) for valid values.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enforceHttps", "tlsSecurityPolicy" ] } } }, "aws:cloudsearch/DomainIndexField:DomainIndexField": { "properties": { "analysisScheme": { "type": "string", "description": "The analysis scheme you want to use for a `text` field. The analysis scheme specifies the language-specific text processing options that are used during indexing.\n" }, "defaultValue": { "type": "string", "description": "The default value for the field. This value is used when no value is specified for the field in the document data.\n" }, "facet": { "type": "boolean", "description": "You can get facet information by enabling this.\n" }, "highlight": { "type": "boolean", "description": "You can highlight information.\n" }, "name": { "type": "string", "description": "A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: `a`-`z` (lower-case letters), `0`-`9`, and `_` (underscore). The name `score` is reserved and cannot be used as a field name.\n" }, "return": { "type": "boolean", "description": "You can enable returning the value of all searchable fields.\n" }, "search": { "type": "boolean", "description": "You can set whether this index should be searchable or not.\n" }, "sort": { "type": "boolean", "description": "You can enable the property to be sortable.\n" }, "sourceFields": { "type": "string", "description": "A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.\n" }, "type": { "type": "string", "description": "The field type. Valid values: `date`, `date-array`, `double`, `double-array`, `int`, `int-array`, `literal`, `literal-array`, `text`, `text-array`.\n" } }, "type": "object", "required": [ "name", "type" ] }, "aws:cloudsearch/DomainScalingParameters:DomainScalingParameters": { "properties": { "desiredInstanceType": { "type": "string", "description": "The instance type that you want to preconfigure for your domain. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_ScalingParameters.html) for valid values.\n" }, "desiredPartitionCount": { "type": "integer", "description": "The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.\n" }, "desiredReplicationCount": { "type": "integer", "description": "The number of replicas you want to preconfigure for each index partition.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredInstanceType", "desiredPartitionCount", "desiredReplicationCount" ] } } }, "aws:cloudtrail/EventDataStoreAdvancedEventSelector:EventDataStoreAdvancedEventSelector": { "properties": { "fieldSelectors": { "type": "array", "items": { "$ref": "#/types/aws:cloudtrail/EventDataStoreAdvancedEventSelectorFieldSelector:EventDataStoreAdvancedEventSelectorFieldSelector" }, "description": "Specifies the selector statements in an advanced event selector. Fields documented below.\n" }, "name": { "type": "string", "description": "Specifies the name of the advanced event selector.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fieldSelectors", "name" ] } } }, "aws:cloudtrail/EventDataStoreAdvancedEventSelectorFieldSelector:EventDataStoreAdvancedEventSelectorFieldSelector": { "properties": { "endsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that includes events that match the last few characters of the event record field specified as the value of `field`.\n" }, "equals": { "type": "array", "items": { "type": "string" }, "description": "A list of values 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.\n" }, "field": { "type": "string", "description": "Specifies a field in an event record on which to filter events to be logged. You can specify only the following values: `readOnly`, `eventSource`, `eventName`, `eventCategory`, `resources.type`, `resources.ARN`.\n" }, "notEndsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the last few characters of the event record field specified as the value of `field`.\n" }, "notEquals": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the exact value of the event record field specified as the value of `field`.\n" }, "notStartsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the first few characters of the event record field specified as the value of `field`.\n" }, "startsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that includes events that match the first few characters of the event record field specified as the value of `field`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endsWiths", "equals", "field", "notEndsWiths", "notEquals", "notStartsWiths", "startsWiths" ] } } }, "aws:cloudtrail/TrailAdvancedEventSelector:TrailAdvancedEventSelector": { "properties": { "fieldSelectors": { "type": "array", "items": { "$ref": "#/types/aws:cloudtrail/TrailAdvancedEventSelectorFieldSelector:TrailAdvancedEventSelectorFieldSelector" }, "description": "Specifies the selector statements in an advanced event selector. Fields documented below.\n" }, "name": { "type": "string", "description": "Name of the trail.\n" } }, "type": "object", "required": [ "fieldSelectors" ] }, "aws:cloudtrail/TrailAdvancedEventSelectorFieldSelector:TrailAdvancedEventSelectorFieldSelector": { "properties": { "endsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that includes events that match the last few characters of the event record field specified as the value of `field`.\n" }, "equals": { "type": "array", "items": { "type": "string" }, "description": "A list of values 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.\n" }, "field": { "type": "string", "description": "Field in an event record on which to filter events to be logged. You can specify only the following values: `readOnly`, `eventSource`, `eventName`, `eventCategory`, `resources.type`, `resources.ARN`.\n" }, "notEndsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the last few characters of the event record field specified as the value of `field`.\n" }, "notEquals": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the exact value of the event record field specified as the value of `field`.\n" }, "notStartsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that excludes events that match the first few characters of the event record field specified as the value of `field`.\n" }, "startsWiths": { "type": "array", "items": { "type": "string" }, "description": "A list of values that includes events that match the first few characters of the event record field specified as the value of `field`.\n" } }, "type": "object", "required": [ "field" ] }, "aws:cloudtrail/TrailEventSelector:TrailEventSelector": { "properties": { "dataResources": { "type": "array", "items": { "$ref": "#/types/aws:cloudtrail/TrailEventSelectorDataResource:TrailEventSelectorDataResource" }, "description": "Configuration block for data events. See details below.\n" }, "excludeManagementEventSources": { "type": "array", "items": { "type": "string" }, "description": "A set of event sources to exclude. Valid values include: `kms.amazonaws.com` and `rdsdata.amazonaws.com`. `include_management_events` must be set to`true` to allow this.\n" }, "includeManagementEvents": { "type": "boolean", "description": "Whether to include management events for your trail. Defaults to `true`.\n" }, "readWriteType": { "type": "string", "description": "Type of events to log. Valid values are `ReadOnly`, `WriteOnly`, `All`. Default value is `All`.\n" } }, "type": "object" }, "aws:cloudtrail/TrailEventSelectorDataResource:TrailEventSelectorDataResource": { "properties": { "type": { "type": "string", "description": "Resource type in which you want to log data events. You can specify only the following value: \"AWS::S3::Object\", \"AWS::Lambda::Function\" and \"AWS::DynamoDB::Table\".\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of ARN strings or partial ARN strings to specify selectors for data audit events over data resources. ARN list is specific to single-valued `type`. For example, `arn:aws:s3:::\u003cbucket name\u003e/` for all objects in a bucket, `arn:aws:s3:::\u003cbucket name\u003e/key` for specific objects, `arn:aws:lambda` for all lambda events within an account, `arn:aws:lambda:\u003cregion\u003e:\u003caccount number\u003e:function:\u003cfunction name\u003e` for a specific Lambda function, `arn:aws:dynamodb` for all DDB events for all tables within an account, or `arn:aws:dynamodb:\u003cregion\u003e:\u003caccount number\u003e:table/\u003ctable name\u003e` for a specific DynamoDB table.\n" } }, "type": "object", "required": [ "type", "values" ] }, "aws:cloudtrail/TrailInsightSelector:TrailInsightSelector": { "properties": { "insightType": { "type": "string", "description": "Type of insights to log on a trail. Valid values are: `ApiCallRateInsight` and `ApiErrorRateInsight`.\n" } }, "type": "object", "required": [ "insightType" ] }, "aws:cloudwatch/CompositeAlarmActionsSuppressor:CompositeAlarmActionsSuppressor": { "properties": { "alarm": { "type": "string", "description": "Can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.\n" }, "extensionPeriod": { "type": "integer", "description": "The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state. After this time, the composite alarm performs its actions.\n" }, "waitPeriod": { "type": "integer", "description": "The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state. After this time, the composite alarm performs its actions.\n" } }, "type": "object", "required": [ "alarm", "extensionPeriod", "waitPeriod" ] }, "aws:cloudwatch/EventConnectionAuthParameters:EventConnectionAuthParameters": { "properties": { "apiKey": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersApiKey:EventConnectionAuthParametersApiKey", "description": "Parameters used for API_KEY authorization. An API key to include in the header for each authentication request. A maximum of 1 are allowed. Conflicts with `basic` and `oauth`. Documented below.\n" }, "basic": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersBasic:EventConnectionAuthParametersBasic", "description": "Parameters used for BASIC authorization. A maximum of 1 are allowed. Conflicts with `api_key` and `oauth`. Documented below.\n" }, "invocationHttpParameters": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParameters:EventConnectionAuthParametersInvocationHttpParameters", "description": "Invocation Http Parameters are additional credentials used to sign each Invocation of the ApiDestination created from this Connection. If the ApiDestination Rule Target has additional HttpParameters, the values will be merged together, with the Connection Invocation Http Parameters taking precedence. Secret values are stored and managed by AWS Secrets Manager. A maximum of 1 are allowed. Documented below.\n" }, "oauth": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauth:EventConnectionAuthParametersOauth", "description": "Parameters used for OAUTH_CLIENT_CREDENTIALS authorization. A maximum of 1 are allowed. Conflicts with `basic` and `api_key`. Documented below.\n" } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersApiKey:EventConnectionAuthParametersApiKey": { "properties": { "key": { "type": "string", "description": "Header Name.\n" }, "value": { "type": "string", "description": "Header Value. Created and stored in AWS Secrets Manager.\n", "secret": true } }, "type": "object", "required": [ "key", "value" ] }, "aws:cloudwatch/EventConnectionAuthParametersBasic:EventConnectionAuthParametersBasic": { "properties": { "password": { "type": "string", "description": "A password for the authorization. Created and stored in AWS Secrets Manager.\n", "secret": true }, "username": { "type": "string", "description": "A username for the authorization.\n" } }, "type": "object", "required": [ "password", "username" ] }, "aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParameters:EventConnectionAuthParametersInvocationHttpParameters": { "properties": { "bodies": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersBody:EventConnectionAuthParametersInvocationHttpParametersBody" }, "description": "Contains additional body string parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersHeader:EventConnectionAuthParametersInvocationHttpParametersHeader" }, "description": "Contains additional header parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersQueryString:EventConnectionAuthParametersInvocationHttpParametersQueryString" }, "description": "Contains additional query string parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersBody:EventConnectionAuthParametersInvocationHttpParametersBody": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersHeader:EventConnectionAuthParametersInvocationHttpParametersHeader": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersInvocationHttpParametersQueryString:EventConnectionAuthParametersInvocationHttpParametersQueryString": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersOauth:EventConnectionAuthParametersOauth": { "properties": { "authorizationEndpoint": { "type": "string", "description": "The URL to the authorization endpoint.\n" }, "clientParameters": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauthClientParameters:EventConnectionAuthParametersOauthClientParameters", "description": "Contains the client parameters for OAuth authorization. Contains the following two parameters.\n" }, "httpMethod": { "type": "string", "description": "A password for the authorization. Created and stored in AWS Secrets Manager.\n" }, "oauthHttpParameters": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParameters:EventConnectionAuthParametersOauthOauthHttpParameters", "description": "OAuth Http Parameters are additional credentials used to sign the request to the authorization endpoint to exchange the OAuth Client information for an access token. Secret values are stored and managed by AWS Secrets Manager. A maximum of 1 are allowed. Documented below.\n" } }, "type": "object", "required": [ "authorizationEndpoint", "httpMethod", "oauthHttpParameters" ] }, "aws:cloudwatch/EventConnectionAuthParametersOauthClientParameters:EventConnectionAuthParametersOauthClientParameters": { "properties": { "clientId": { "type": "string", "description": "The client ID for the credentials to use for authorization. Created and stored in AWS Secrets Manager.\n" }, "clientSecret": { "type": "string", "description": "The client secret for the credentials to use for authorization. Created and stored in AWS Secrets Manager.\n", "secret": true } }, "type": "object", "required": [ "clientId", "clientSecret" ] }, "aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParameters:EventConnectionAuthParametersOauthOauthHttpParameters": { "properties": { "bodies": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersBody:EventConnectionAuthParametersOauthOauthHttpParametersBody" }, "description": "Contains additional body string parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersHeader:EventConnectionAuthParametersOauthOauthHttpParametersHeader" }, "description": "Contains additional header parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersQueryString:EventConnectionAuthParametersOauthOauthHttpParametersQueryString" }, "description": "Contains additional query string parameters for the connection. You can include up to 100 additional body string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB. Each parameter can contain the following:\n" } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersBody:EventConnectionAuthParametersOauthOauthHttpParametersBody": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersHeader:EventConnectionAuthParametersOauthOauthHttpParametersHeader": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionAuthParametersOauthOauthHttpParametersQueryString:EventConnectionAuthParametersOauthOauthHttpParametersQueryString": { "properties": { "isValueSecret": { "type": "boolean", "description": "Specified whether the value is secret.\n" }, "key": { "type": "string", "description": "The key for the parameter.\n" }, "value": { "type": "string", "description": "The value associated with the key. Created and stored in AWS Secrets Manager if is secret.\n", "secret": true } }, "type": "object" }, "aws:cloudwatch/EventConnectionInvocationConnectivityParameters:EventConnectionInvocationConnectivityParameters": { "properties": { "resourceParameters": { "$ref": "#/types/aws:cloudwatch/EventConnectionInvocationConnectivityParametersResourceParameters:EventConnectionInvocationConnectivityParametersResourceParameters", "description": "The parameters for EventBridge to use when invoking the resource endpoint. Documented below.\n" } }, "type": "object", "required": [ "resourceParameters" ] }, "aws:cloudwatch/EventConnectionInvocationConnectivityParametersResourceParameters:EventConnectionInvocationConnectivityParametersResourceParameters": { "properties": { "resourceAssociationArn": { "type": "string" }, "resourceConfigurationArn": { "type": "string", "description": "ARN of the Amazon VPC Lattice resource configuration for the resource endpoint.\n" } }, "type": "object", "required": [ "resourceConfigurationArn" ], "language": { "nodejs": { "requiredOutputs": [ "resourceAssociationArn", "resourceConfigurationArn" ] } } }, "aws:cloudwatch/EventEndpointEventBus:EventEndpointEventBus": { "properties": { "eventBusArn": { "type": "string", "description": "The ARN of the event bus the endpoint is associated with.\n" } }, "type": "object", "required": [ "eventBusArn" ] }, "aws:cloudwatch/EventEndpointReplicationConfig:EventEndpointReplicationConfig": { "properties": { "state": { "type": "string", "description": "The state of event replication. Valid values: `ENABLED`, `DISABLED`. The default state is `ENABLED`, which means you must supply a `role_arn`. If you don't have a `role_arn` or you don't want event replication enabled, set `state` to `DISABLED`.\n" } }, "type": "object" }, "aws:cloudwatch/EventEndpointRoutingConfig:EventEndpointRoutingConfig": { "properties": { "failoverConfig": { "$ref": "#/types/aws:cloudwatch/EventEndpointRoutingConfigFailoverConfig:EventEndpointRoutingConfigFailoverConfig", "description": "Parameters used for failover. This includes what triggers failover and what happens when it's triggered. Documented below.\n" } }, "type": "object", "required": [ "failoverConfig" ] }, "aws:cloudwatch/EventEndpointRoutingConfigFailoverConfig:EventEndpointRoutingConfigFailoverConfig": { "properties": { "primary": { "$ref": "#/types/aws:cloudwatch/EventEndpointRoutingConfigFailoverConfigPrimary:EventEndpointRoutingConfigFailoverConfigPrimary", "description": "Parameters used for the primary Region. Documented below.\n" }, "secondary": { "$ref": "#/types/aws:cloudwatch/EventEndpointRoutingConfigFailoverConfigSecondary:EventEndpointRoutingConfigFailoverConfigSecondary", "description": "Parameters used for the secondary Region, the Region that events are routed to when failover is triggered or event replication is enabled. Documented below.\n" } }, "type": "object", "required": [ "primary", "secondary" ] }, "aws:cloudwatch/EventEndpointRoutingConfigFailoverConfigPrimary:EventEndpointRoutingConfigFailoverConfigPrimary": { "properties": { "healthCheck": { "type": "string", "description": "The ARN of the health check used by the endpoint to determine whether failover is triggered.\n" } }, "type": "object" }, "aws:cloudwatch/EventEndpointRoutingConfigFailoverConfigSecondary:EventEndpointRoutingConfigFailoverConfigSecondary": { "properties": { "route": { "type": "string", "description": "The name of the secondary Region.\n" } }, "type": "object" }, "aws:cloudwatch/EventPermissionCondition:EventPermissionCondition": { "properties": { "key": { "type": "string", "description": "Key for the condition. Valid values: `aws:PrincipalOrgID`.\n" }, "type": { "type": "string", "description": "Type of condition. Value values: `StringEquals`.\n" }, "value": { "type": "string", "description": "Value for the key.\n" } }, "type": "object", "required": [ "key", "type", "value" ] }, "aws:cloudwatch/EventTargetAppsyncTarget:EventTargetAppsyncTarget": { "properties": { "graphqlOperation": { "type": "string", "description": "Contains the GraphQL mutation to be parsed and executed.\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetBatchTarget:EventTargetBatchTarget": { "properties": { "arraySize": { "type": "integer", "description": "The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.\n" }, "jobAttempts": { "type": "integer", "description": "The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.\n" }, "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.\n" }, "jobName": { "type": "string", "description": "The name to use for this execution of the job, if the target is an AWS Batch job.\n" } }, "type": "object", "required": [ "jobDefinition", "jobName" ] }, "aws:cloudwatch/EventTargetDeadLetterConfig:EventTargetDeadLetterConfig": { "properties": { "arn": { "type": "string", "description": "ARN of the SQS queue specified as the target for the dead-letter queue.\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetEcsTarget:EventTargetEcsTarget": { "properties": { "capacityProviderStrategies": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventTargetEcsTargetCapacityProviderStrategy:EventTargetEcsTargetCapacityProviderStrategy" }, "description": "The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.\n" }, "enableEcsManagedTags": { "type": "boolean", "description": "Specifies whether to enable Amazon ECS managed tags for the task.\n" }, "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.\n" }, "group": { "type": "string", "description": "Specifies an ECS task group for the task. The maximum length is 255 characters.\n" }, "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. Valid values include: `EC2`, `EXTERNAL`, or `FARGATE`.\n" }, "networkConfiguration": { "$ref": "#/types/aws:cloudwatch/EventTargetEcsTargetNetworkConfiguration:EventTargetEcsTargetNetworkConfiguration", "description": "Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if `launch_type` is `FARGATE` because the awsvpc mode is required for Fargate tasks.\n" }, "orderedPlacementStrategies": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventTargetEcsTargetOrderedPlacementStrategy:EventTargetEcsTargetOrderedPlacementStrategy" }, "description": "An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.\n" }, "placementConstraints": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventTargetEcsTargetPlacementConstraint:EventTargetEcsTargetPlacementConstraint" }, "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). See Below.\n" }, "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`. This is used only if LaunchType is FARGATE. For more information about valid platform versions, see [AWS Fargate Platform Versions](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\n" }, "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. The only valid value is: `TASK_DEFINITION`.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags to assign to ecs resources.\n" }, "taskCount": { "type": "integer", "description": "The number of tasks to create based on the TaskDefinition. Defaults to `1`.\n" }, "taskDefinitionArn": { "type": "string", "description": "The ARN of the task definition to use if the event target is an Amazon ECS cluster.\n" } }, "type": "object", "required": [ "taskDefinitionArn" ] }, "aws:cloudwatch/EventTargetEcsTargetCapacityProviderStrategy:EventTargetEcsTargetCapacityProviderStrategy": { "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. Defaults to `0`.\n" }, "capacityProvider": { "type": "string", "description": "Short name of the capacity provider.\n" }, "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" } }, "type": "object", "required": [ "capacityProvider" ] }, "aws:cloudwatch/EventTargetEcsTargetNetworkConfiguration:EventTargetEcsTargetNetworkConfiguration": { "properties": { "assignPublicIp": { "type": "boolean", "description": "Assign a public IP address to the ENI (Fargate launch type only). Valid values are `true` or `false`. Defaults to `false`.\n\nFor more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\n" }, "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.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The subnets associated with the task or service.\n" } }, "type": "object", "required": [ "subnets" ] }, "aws:cloudwatch/EventTargetEcsTargetOrderedPlacementStrategy:EventTargetEcsTargetOrderedPlacementStrategy": { "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. For more information, see [Amazon ECS task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).\n" }, "type": { "type": "string", "description": "Type of placement strategy. The only valid values at this time are `binpack`, `random` and `spread`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:cloudwatch/EventTargetEcsTargetPlacementConstraint:EventTargetEcsTargetPlacementConstraint": { "properties": { "expression": { "type": "string", "description": "Cluster Query Language expression to apply to the constraint. Does not need to be specified for the `distinctInstance` type. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).\n" }, "type": { "type": "string", "description": "Type of constraint. The only valid values at this time are `memberOf` and `distinctInstance`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:cloudwatch/EventTargetHttpTarget:EventTargetHttpTarget": { "properties": { "headerParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Enables you to specify HTTP headers to add to the request.\n" }, "pathParameterValues": { "type": "array", "items": { "type": "string" }, "description": "The list of values that correspond sequentially to any path variables in your endpoint ARN (for example `arn:aws:execute-api:us-east-1:123456:myapi/*/POST/pets/*`).\n" }, "queryStringParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Represents keys/values of query string parameters that are appended to the invoked endpoint.\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetInputTransformer:EventTargetInputTransformer": { "properties": { "inputPaths": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key value pairs specified in the form of JSONPath (for example, time = $.time)\n* You can have as many as 100 key-value pairs.\n* You must use JSON dot notation, not bracket notation.\n* The keys can't start with \"AWS\".\n" }, "inputTemplate": { "type": "string", "description": "Template to customize data sent to the target. Must be valid JSON. To send a string value, the string value must include double quotes.\n" } }, "type": "object", "required": [ "inputTemplate" ] }, "aws:cloudwatch/EventTargetKinesisTarget:EventTargetKinesisTarget": { "properties": { "partitionKeyPath": { "type": "string", "description": "The JSON path to be extracted from the event and used as the partition key.\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetRedshiftTarget:EventTargetRedshiftTarget": { "properties": { "database": { "type": "string", "description": "The name of the database.\n" }, "dbUser": { "type": "string", "description": "The database user name.\n" }, "secretsManagerArn": { "type": "string", "description": "The name or ARN of the secret that enables access to the database.\n" }, "sql": { "type": "string", "description": "The SQL statement text to run.\n" }, "statementName": { "type": "string", "description": "The name of the SQL statement.\n" }, "withEvent": { "type": "boolean", "description": "Indicates whether to send an event back to EventBridge after the SQL statement runs.\n" } }, "type": "object", "required": [ "database" ] }, "aws:cloudwatch/EventTargetRetryPolicy:EventTargetRetryPolicy": { "properties": { "maximumEventAgeInSeconds": { "type": "integer", "description": "The age in seconds to continue to make retry attempts.\n" }, "maximumRetryAttempts": { "type": "integer", "description": "maximum number of retry attempts to make before the request fails\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetRunCommandTarget:EventTargetRunCommandTarget": { "properties": { "key": { "type": "string", "description": "Can be either `tag:tag-key` or `InstanceIds`.\n" }, "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.\n" } }, "type": "object", "required": [ "key", "values" ] }, "aws:cloudwatch/EventTargetSagemakerPipelineTarget:EventTargetSagemakerPipelineTarget": { "properties": { "pipelineParameterLists": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/EventTargetSagemakerPipelineTargetPipelineParameterList:EventTargetSagemakerPipelineTargetPipelineParameterList" }, "description": "List of Parameter names and values for SageMaker AI Model Building Pipeline execution.\n" } }, "type": "object" }, "aws:cloudwatch/EventTargetSagemakerPipelineTargetPipelineParameterList:EventTargetSagemakerPipelineTargetPipelineParameterList": { "properties": { "name": { "type": "string", "description": "Name of parameter to start execution of a SageMaker AI Model Building Pipeline.\n" }, "value": { "type": "string", "description": "Value of parameter to start execution of a SageMaker AI Model Building Pipeline.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:cloudwatch/EventTargetSqsTarget:EventTargetSqsTarget": { "properties": { "messageGroupId": { "type": "string", "description": "The FIFO message group ID to use as the target.\n" } }, "type": "object" }, "aws:cloudwatch/InternetMonitorHealthEventsConfig:InternetMonitorHealthEventsConfig": { "properties": { "availabilityScoreThreshold": { "type": "number", "description": "The health event threshold percentage set for availability scores.\n" }, "performanceScoreThreshold": { "type": "number", "description": "The health event threshold percentage set for performance scores.\n" } }, "type": "object" }, "aws:cloudwatch/InternetMonitorInternetMeasurementsLogDelivery:InternetMonitorInternetMeasurementsLogDelivery": { "properties": { "s3Config": { "$ref": "#/types/aws:cloudwatch/InternetMonitorInternetMeasurementsLogDeliveryS3Config:InternetMonitorInternetMeasurementsLogDeliveryS3Config" } }, "type": "object" }, "aws:cloudwatch/InternetMonitorInternetMeasurementsLogDeliveryS3Config:InternetMonitorInternetMeasurementsLogDeliveryS3Config": { "properties": { "bucketName": { "type": "string" }, "bucketPrefix": { "type": "string" }, "logDeliveryStatus": { "type": "string" } }, "type": "object", "required": [ "bucketName" ] }, "aws:cloudwatch/LogDeliveryDestinationDeliveryDestinationConfiguration:LogDeliveryDestinationDeliveryDestinationConfiguration": { "properties": { "destinationResourceArn": { "type": "string", "description": "The ARN of the AWS destination that this delivery destination represents.\n" } }, "type": "object", "required": [ "destinationResourceArn" ] }, "aws:cloudwatch/LogDeliveryS3DeliveryConfiguration:LogDeliveryS3DeliveryConfiguration": { "properties": { "enableHiveCompatiblePath": { "type": "boolean", "description": "This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.\n" }, "suffixPath": { "type": "string", "description": "This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source.\n" } }, "type": "object", "required": [ "enableHiveCompatiblePath", "suffixPath" ] }, "aws:cloudwatch/LogMetricFilterMetricTransformation:LogMetricFilterMetricTransformation": { "properties": { "defaultValue": { "type": "string", "description": "The value to emit when a filter pattern does not match a log event. Conflicts with `dimensions`.\n" }, "dimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of fields to use as dimensions for the metric. Up to 3 dimensions are allowed. Conflicts with `default_value`.\n" }, "name": { "type": "string", "description": "The name of the CloudWatch metric to which the monitored log information should be published (e.g., `ErrorCount`)\n" }, "namespace": { "type": "string", "description": "The destination namespace of the CloudWatch metric.\n" }, "unit": { "type": "string", "description": "The unit to assign to the metric. If you omit this, the unit is set as `None`.\n" }, "value": { "type": "string", "description": "What to publish to the metric. For example, if you're counting the occurrences of a particular term like \"Error\", the value will be \"1\" for each occurrence. If you're counting the bytes transferred the published value will be the value in the log event.\n" } }, "type": "object", "required": [ "name", "namespace", "value" ] }, "aws:cloudwatch/MetricAlarmMetricQuery:MetricAlarmMetricQuery": { "properties": { "accountId": { "type": "string", "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.\n" }, "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 in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax).\n" }, "id": { "type": "string", "description": "A short name used to tie this object to the results in the response. 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.\n" }, "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.\n" }, "metric": { "$ref": "#/types/aws:cloudwatch/MetricAlarmMetricQueryMetric:MetricAlarmMetricQueryMetric", "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" }, "period": { "type": "integer", "description": "Granularity in seconds of returned data points.\nFor metrics with regular resolution, valid values are any multiple of `60`.\nFor high-resolution metrics, valid values are `1`, `5`, `10`, `30`, or any multiple of `60`.\n" }, "returnData": { "type": "boolean", "description": "Specify exactly one `metric_query` to be `true` to use that `metric_query` result as the alarm.\n\n\u003e **NOTE:** You must specify either `metric` or `expression`. Not both.\n" } }, "type": "object", "required": [ "id" ] }, "aws:cloudwatch/MetricAlarmMetricQueryMetric:MetricAlarmMetricQueryMetric": { "properties": { "dimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The dimensions for this metric. For the list of available dimensions see the AWS documentation [here](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).\n" }, "metricName": { "type": "string", "description": "The name for this metric.\nSee docs for [supported metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).\n" }, "namespace": { "type": "string", "description": "The namespace for this metric. See docs for the [list of namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/aws-namespaces.html).\nSee docs for [supported metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).\n" }, "period": { "type": "integer", "description": "Granularity in seconds of returned data points.\nFor metrics with regular resolution, valid values are any multiple of `60`.\nFor high-resolution metrics, valid values are `1`, `5`, `10`, `30`, or any multiple of `60`.\n" }, "stat": { "type": "string", "description": "The statistic to apply to this metric.\nSee docs for [supported statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html).\n" }, "unit": { "type": "string", "description": "The unit for this metric.\n" } }, "type": "object", "required": [ "metricName", "period", "stat" ] }, "aws:cloudwatch/MetricStreamExcludeFilter:MetricStreamExcludeFilter": { "properties": { "metricNames": { "type": "array", "items": { "type": "string" }, "description": "An array that defines the metrics you want to exclude for this metric namespace\n" }, "namespace": { "type": "string", "description": "Name of the metric namespace in the filter.\n" } }, "type": "object", "required": [ "namespace" ] }, "aws:cloudwatch/MetricStreamIncludeFilter:MetricStreamIncludeFilter": { "properties": { "metricNames": { "type": "array", "items": { "type": "string" }, "description": "An array that defines the metrics you want to include for this metric namespace\n" }, "namespace": { "type": "string", "description": "Name of the metric namespace in the filter.\n" } }, "type": "object", "required": [ "namespace" ] }, "aws:cloudwatch/MetricStreamStatisticsConfiguration:MetricStreamStatisticsConfiguration": { "properties": { "additionalStatistics": { "type": "array", "items": { "type": "string" }, "description": "The additional statistics to stream for the metrics listed in `include_metrics`.\n" }, "includeMetrics": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/MetricStreamStatisticsConfigurationIncludeMetric:MetricStreamStatisticsConfigurationIncludeMetric" }, "description": "An array that defines the metrics that are to have additional statistics streamed. See details below.\n" } }, "type": "object", "required": [ "additionalStatistics", "includeMetrics" ] }, "aws:cloudwatch/MetricStreamStatisticsConfigurationIncludeMetric:MetricStreamStatisticsConfigurationIncludeMetric": { "properties": { "metricName": { "type": "string", "description": "The name of the metric.\n" }, "namespace": { "type": "string" } }, "type": "object", "required": [ "metricName", "namespace" ] }, "aws:cloudwatch/getContributorManagedInsightRulesManagedRule:getContributorManagedInsightRulesManagedRule": { "properties": { "resourceArn": { "type": "string", "description": "ARN of an Amazon Web Services resource that has managed Contributor Insights rules.\n\nThe following arguments are optional:\n\nThere are no optional arguments.\n" }, "ruleStates": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/getContributorManagedInsightRulesManagedRuleRuleState:getContributorManagedInsightRulesManagedRuleRuleState" }, "description": "Describes the state of a managed rule. If the rule is enabled, it contains information about the Contributor Insights rule that contains information about the related Amazon Web Services resource. See `rule_state reference` below for details.\n" }, "templateName": { "type": "string", "description": "Template name for the managed rule. Used to enable managed rules using `PutManagedInsightRules`.\n" } }, "type": "object", "required": [ "resourceArn", "ruleStates", "templateName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudwatch/getContributorManagedInsightRulesManagedRuleRuleState:getContributorManagedInsightRulesManagedRuleRuleState": { "properties": { "ruleName": { "type": "string", "description": "Name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource.\n" }, "state": { "type": "string", "description": "Indicates whether the rule is enabled or disabled.\n" } }, "type": "object", "required": [ "ruleName", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudwatch/getEventBusesEventBus:getEventBusesEventBus": { "properties": { "arn": { "type": "string", "description": "The ARN of the event bus.\n" }, "creationTime": { "type": "string", "description": "The time the event bus was created.\n" }, "description": { "type": "string", "description": "The event bus description.\n" }, "lastModifiedTime": { "type": "string", "description": "The time the event bus was last modified.\n" }, "name": { "type": "string", "description": "The name of the event bus.\n" }, "policy": { "type": "string", "description": "The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.\n" } }, "type": "object", "required": [ "arn", "creationTime", "description", "lastModifiedTime", "name", "policy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentConfiguration:getLogDataProtectionPolicyDocumentConfiguration": { "properties": { "customDataIdentifiers": { "type": "array", "items": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentConfigurationCustomDataIdentifier:getLogDataProtectionPolicyDocumentConfigurationCustomDataIdentifier" }, "description": "Configures custom regular expressions to detect sensitive data. Read more in [Custom data identifiers](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL-custom-data-identifiers.html).\n" } }, "type": "object" }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentConfigurationCustomDataIdentifier:getLogDataProtectionPolicyDocumentConfigurationCustomDataIdentifier": { "properties": { "name": { "type": "string", "description": "Name of the custom data idenfitier\n" }, "regex": { "type": "string", "description": "Regular expression to match sensitive data\n" } }, "type": "object", "required": [ "name", "regex" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatement:getLogDataProtectionPolicyDocumentStatement": { "properties": { "dataIdentifiers": { "type": "array", "items": { "type": "string" }, "description": "Set of at least 1 sensitive data identifiers that you want to mask. Read more in [Types of data that you can protect](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/protect-sensitive-log-data-types.html).\n" }, "operation": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperation:getLogDataProtectionPolicyDocumentStatementOperation", "description": "Configures the data protection operation applied by this statement.\n" }, "sid": { "type": "string", "description": "Name of this statement.\n" } }, "type": "object", "required": [ "dataIdentifiers", "operation" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperation:getLogDataProtectionPolicyDocumentStatementOperation": { "properties": { "audit": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAudit:getLogDataProtectionPolicyDocumentStatementOperationAudit", "description": "Configures the detection of sensitive data.\n" }, "deidentify": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationDeidentify:getLogDataProtectionPolicyDocumentStatementOperationDeidentify", "description": "Configures the masking of sensitive data.\n\n\u003e Every policy statement must specify exactly one operation.\n" } }, "type": "object" }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAudit:getLogDataProtectionPolicyDocumentStatementOperationAudit": { "properties": { "findingsDestination": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestination:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestination", "description": "Configures destinations to send audit findings to.\n" } }, "type": "object", "required": [ "findingsDestination" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestination:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestination": { "properties": { "cloudwatchLogs": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationCloudwatchLogs:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationCloudwatchLogs", "description": "Configures CloudWatch Logs as a findings destination.\n" }, "firehose": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationFirehose:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationFirehose", "description": "Configures Kinesis Firehose as a findings destination.\n" }, "s3": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationS3:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationS3", "description": "Configures S3 as a findings destination.\n" } }, "type": "object" }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationCloudwatchLogs:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationCloudwatchLogs": { "properties": { "logGroup": { "type": "string", "description": "Name of the CloudWatch Log Group to send findings to.\n" } }, "type": "object", "required": [ "logGroup" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationFirehose:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationFirehose": { "properties": { "deliveryStream": { "type": "string", "description": "Name of the Kinesis Firehose Delivery Stream to send findings to.\n" } }, "type": "object", "required": [ "deliveryStream" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationS3:getLogDataProtectionPolicyDocumentStatementOperationAuditFindingsDestinationS3": { "properties": { "bucket": { "type": "string", "description": "Name of the S3 Bucket to send findings to.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationDeidentify:getLogDataProtectionPolicyDocumentStatementOperationDeidentify": { "properties": { "maskConfig": { "$ref": "#/types/aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationDeidentifyMaskConfig:getLogDataProtectionPolicyDocumentStatementOperationDeidentifyMaskConfig", "description": "An empty object that configures masking.\n" } }, "type": "object", "required": [ "maskConfig" ] }, "aws:cloudwatch/getLogDataProtectionPolicyDocumentStatementOperationDeidentifyMaskConfig:getLogDataProtectionPolicyDocumentStatementOperationDeidentifyMaskConfig": { "type": "object" }, "aws:codeartifact/RepositoryExternalConnections:RepositoryExternalConnections": { "properties": { "externalConnectionName": { "type": "string", "description": "The name of the external connection associated with a repository.\n" }, "packageFormat": { "type": "string" }, "status": { "type": "string" } }, "type": "object", "required": [ "externalConnectionName" ], "language": { "nodejs": { "requiredOutputs": [ "externalConnectionName", "packageFormat", "status" ] } } }, "aws:codeartifact/RepositoryUpstream:RepositoryUpstream": { "properties": { "repositoryName": { "type": "string", "description": "The name of an upstream repository.\n" } }, "type": "object", "required": [ "repositoryName" ] }, "aws:codebuild/FleetComputeConfiguration:FleetComputeConfiguration": { "properties": { "disk": { "type": "integer", "description": "Amount of disk space of the instance type included in the fleet.\n" }, "machineType": { "type": "string", "description": "Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`.\n" }, "memory": { "type": "integer", "description": "Amount of memory of the instance type included in the fleet.\n" }, "vcpu": { "type": "integer", "description": "Number of vCPUs of the instance type included in the fleet.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "disk", "memory", "vcpu" ] } } }, "aws:codebuild/FleetScalingConfiguration:FleetScalingConfiguration": { "properties": { "desiredCapacity": { "type": "integer" }, "maxCapacity": { "type": "integer", "description": "Maximum number of instances in the fleet when auto-scaling.\n" }, "scalingType": { "type": "string", "description": "Scaling type for a compute fleet. Valid value: `TARGET_TRACKING_SCALING`.\n" }, "targetTrackingScalingConfigs": { "type": "array", "items": { "$ref": "#/types/aws:codebuild/FleetScalingConfigurationTargetTrackingScalingConfig:FleetScalingConfigurationTargetTrackingScalingConfig" }, "description": "Configuration block. Detailed below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredCapacity" ] } } }, "aws:codebuild/FleetScalingConfigurationTargetTrackingScalingConfig:FleetScalingConfigurationTargetTrackingScalingConfig": { "properties": { "metricType": { "type": "string", "description": "Metric type to determine auto-scaling. Valid value: `FLEET_UTILIZATION_RATE`.\n" }, "targetValue": { "type": "number", "description": "Value of metricType when to start scaling.\n" } }, "type": "object" }, "aws:codebuild/FleetStatus:FleetStatus": { "properties": { "context": { "type": "string", "description": "Additional information about a compute fleet.\n" }, "message": { "type": "string", "description": "Message associated with the status of a compute fleet.\n" }, "statusCode": { "type": "string", "description": "Status code of the compute fleet.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "context", "message", "statusCode" ] } } }, "aws:codebuild/FleetVpcConfig:FleetVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of one or more security groups IDs in your Amazon VPC.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "A list of one or more subnet IDs in your Amazon VPC.\n" }, "vpcId": { "type": "string", "description": "The ID of the Amazon VPC.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnets", "vpcId" ] }, "aws:codebuild/ProjectArtifacts:ProjectArtifacts": { "properties": { "artifactIdentifier": { "type": "string", "description": "Artifact identifier. Must be the same specified inside the AWS CodeBuild build\nspecification.\n" }, "bucketOwnerAccess": { "type": "string", "description": "Specifies the bucket owner's access for objects that another account uploads to\ntheir Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these\nobjects. This property allows you to give the bucket owner access to these objects. Valid values are `NONE`,\n`READ_ONLY`, and `FULL`. your CodeBuild service role must have the `s3:PutBucketAcl` permission. This permission\nallows CodeBuild to modify the access control list for the bucket.\n" }, "encryptionDisabled": { "type": "boolean", "description": "Whether to disable encrypting output artifacts. If `type` is set to `NO_ARTIFACTS`,\nthis value is ignored. Defaults to `false`.\n" }, "location": { "type": "string", "description": "Information about the build output artifact location. If `type` is set to `CODEPIPELINE` or\n`NO_ARTIFACTS`, this value is ignored. If `type` is set to `S3`, this is the name of the output bucket.\n" }, "name": { "type": "string", "description": "Name of the project. If `type` is set to `S3`, this is the name of the output artifact object\n" }, "namespaceType": { "type": "string", "description": "Namespace to use in storing build artifacts. If `type` is set to `S3`, then valid values\nare `BUILD_ID`, `NONE`.\n" }, "overrideArtifactName": { "type": "boolean", "description": "Whether a name specified in the build specification overrides the artifact name.\n" }, "packaging": { "type": "string", "description": "Type of build output artifact to create. If `type` is set to `S3`, valid values are `NONE`,\n`ZIP`\n" }, "path": { "type": "string", "description": "If `type` is set to `S3`, this is the path to the output artifact.\n" }, "type": { "type": "string", "description": "Build output artifact's type. Valid values: `CODEPIPELINE`, `NO_ARTIFACTS`, `S3`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:codebuild/ProjectBuildBatchConfig:ProjectBuildBatchConfig": { "properties": { "combineArtifacts": { "type": "boolean", "description": "Specifies if the build artifacts for the batch build should be combined into a single\nartifact location.\n" }, "restrictions": { "$ref": "#/types/aws:codebuild/ProjectBuildBatchConfigRestrictions:ProjectBuildBatchConfigRestrictions", "description": "Configuration block specifying the restrictions for the batch build. Detailed below.\n" }, "serviceRole": { "type": "string", "description": "Specifies the service role ARN for the batch build project.\n" }, "timeoutInMins": { "type": "integer", "description": "Specifies the maximum amount of time, in minutes, that the batch build must be\ncompleted in.\n" } }, "type": "object", "required": [ "serviceRole" ] }, "aws:codebuild/ProjectBuildBatchConfigRestrictions:ProjectBuildBatchConfigRestrictions": { "properties": { "computeTypesAlloweds": { "type": "array", "items": { "type": "string" }, "description": "An array of strings that specify the compute types that are allowed for the batch\nbuild.\nSee [Build environment compute types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html)\nin the AWS CodeBuild User Guide for these values.\n" }, "maximumBuildsAllowed": { "type": "integer", "description": "Specifies the maximum number of builds allowed.\n" } }, "type": "object" }, "aws:codebuild/ProjectCache:ProjectCache": { "properties": { "location": { "type": "string", "description": "Location where the AWS CodeBuild project stores cached resources. For\ntype `S3`, the value must be a valid S3 bucket name/prefix.\n" }, "modes": { "type": "array", "items": { "type": "string" }, "description": "Specifies settings that AWS CodeBuild uses to store and reuse build\ndependencies. Valid values: `LOCAL_SOURCE_CACHE`, `LOCAL_DOCKER_LAYER_CACHE`, `LOCAL_CUSTOM_CACHE`.\n" }, "type": { "type": "string", "description": "Type of storage that will be used for the AWS CodeBuild project cache. Valid values: `NO_CACHE`,\n`LOCAL`, `S3`. Defaults to `NO_CACHE`.\n" } }, "type": "object" }, "aws:codebuild/ProjectEnvironment:ProjectEnvironment": { "properties": { "certificate": { "type": "string", "description": "ARN of the S3 bucket, path prefix and object key that contains the PEM-encoded certificate.\n" }, "computeType": { "type": "string", "description": "Information about the compute resources the build project will use. Valid values:\n`BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`, `BUILD_GENERAL1_2XLARGE`, `BUILD_LAMBDA_1GB`,\n`BUILD_LAMBDA_2GB`, `BUILD_LAMBDA_4GB`, `BUILD_LAMBDA_8GB`, `BUILD_LAMBDA_10GB`. `BUILD_GENERAL1_SMALL` is only valid\nif `type` is set to `LINUX_CONTAINER`. When `type` is set to `LINUX_GPU_CONTAINER`, `compute_type` must be\n`BUILD_GENERAL1_LARGE`. When `type` is set to `LINUX_LAMBDA_CONTAINER` or `ARM_LAMBDA_CONTAINER`, `compute_type` must\nbe `BUILD_LAMBDA_XGB`.`\n" }, "environmentVariables": { "type": "array", "items": { "$ref": "#/types/aws:codebuild/ProjectEnvironmentEnvironmentVariable:ProjectEnvironmentEnvironmentVariable" }, "description": "Configuration block. Detailed below.\n" }, "fleet": { "$ref": "#/types/aws:codebuild/ProjectEnvironmentFleet:ProjectEnvironmentFleet", "description": "Configuration block. Detailed below.\n" }, "image": { "type": "string", "description": "Docker image to use for this build project. Valid values\ninclude [Docker images provided by CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) (\ne.g `aws/codebuild/amazonlinux2-x86_64-standard:4.0`), [Docker Hub images](https://hub.docker.com/) (e.g.,\n`pulumi/pulumi:latest`), and full Docker repository URIs such as those for ECR (e.g.,\n`137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest`).\n" }, "imagePullCredentialsType": { "type": "string", "description": "Type of credentials AWS CodeBuild uses to pull images in your build. Valid\nvalues: `CODEBUILD`, `SERVICE_ROLE`. When you use a cross-account or private registry image, you must use SERVICE_ROLE\ncredentials. When you use an AWS CodeBuild curated image, you must use CodeBuild credentials. Defaults to `CODEBUILD`.\n" }, "privilegedMode": { "type": "boolean", "description": "Whether to enable running the Docker daemon inside a Docker container. Defaults to\n`false`.\n" }, "registryCredential": { "$ref": "#/types/aws:codebuild/ProjectEnvironmentRegistryCredential:ProjectEnvironmentRegistryCredential", "description": "Configuration block. Detailed below.\n" }, "type": { "type": "string", "description": "Type of build environment to use for related builds. Valid values: `LINUX_CONTAINER`,\n`LINUX_GPU_CONTAINER`, `WINDOWS_CONTAINER` (deprecated), `WINDOWS_SERVER_2019_CONTAINER`, `ARM_CONTAINER`,\n`LINUX_LAMBDA_CONTAINER`, `ARM_LAMBDA_CONTAINER`. For additional information, see\nthe [CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html).\n" } }, "type": "object", "required": [ "computeType", "image", "type" ] }, "aws:codebuild/ProjectEnvironmentEnvironmentVariable:ProjectEnvironmentEnvironmentVariable": { "properties": { "name": { "type": "string", "description": "Environment variable's name or key.\n" }, "type": { "type": "string", "description": "Type of environment variable. Valid values: `PARAMETER_STORE`, `PLAINTEXT`, `SECRETS_MANAGER`.\n" }, "value": { "type": "string", "description": "Environment variable's value.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:codebuild/ProjectEnvironmentFleet:ProjectEnvironmentFleet": { "properties": { "fleetArn": { "type": "string", "description": "Compute fleet ARN for the build project.\n" } }, "type": "object" }, "aws:codebuild/ProjectEnvironmentRegistryCredential:ProjectEnvironmentRegistryCredential": { "properties": { "credential": { "type": "string", "description": "ARN or name of credentials created using AWS Secrets Manager.\n" }, "credentialProvider": { "type": "string", "description": "Service that created the credentials to access a private Docker registry. Valid\nvalue: `SECRETS_MANAGER` (AWS Secrets Manager).\n" } }, "type": "object", "required": [ "credential", "credentialProvider" ] }, "aws:codebuild/ProjectFileSystemLocation:ProjectFileSystemLocation": { "properties": { "identifier": { "type": "string", "description": "The name used to access a file system created by Amazon EFS. CodeBuild creates an\nenvironment variable by appending the identifier in all capital letters to CODEBUILD\\_. For example, if you specify\nmy-efs for identifier, a new environment variable is create named CODEBUILD_MY-EFS.\n" }, "location": { "type": "string", "description": "A string that specifies the location of the file system created by Amazon EFS. Its format is\n`efs-dns-name:/directory-path`.\n" }, "mountOptions": { "type": "string", "description": "The mount options for a file system created by AWS EFS.\n" }, "mountPoint": { "type": "string", "description": "The location in the container where you mount the file system.\n" }, "type": { "type": "string", "description": "The type of the file system. The one supported type is `EFS`.\n" } }, "type": "object" }, "aws:codebuild/ProjectLogsConfig:ProjectLogsConfig": { "properties": { "cloudwatchLogs": { "$ref": "#/types/aws:codebuild/ProjectLogsConfigCloudwatchLogs:ProjectLogsConfigCloudwatchLogs", "description": "Configuration block. Detailed below.\n" }, "s3Logs": { "$ref": "#/types/aws:codebuild/ProjectLogsConfigS3Logs:ProjectLogsConfigS3Logs", "description": "Configuration block. Detailed below.\n" } }, "type": "object" }, "aws:codebuild/ProjectLogsConfigCloudwatchLogs:ProjectLogsConfigCloudwatchLogs": { "properties": { "groupName": { "type": "string", "description": "Group name of the logs in CloudWatch Logs.\n" }, "status": { "type": "string", "description": "Current status of logs in CloudWatch Logs for a build project. Valid values: `ENABLED`,\n`DISABLED`. Defaults to `ENABLED`.\n" }, "streamName": { "type": "string", "description": "Prefix of the log stream name of the logs in CloudWatch Logs.\n" } }, "type": "object" }, "aws:codebuild/ProjectLogsConfigS3Logs:ProjectLogsConfigS3Logs": { "properties": { "bucketOwnerAccess": { "type": "string", "description": "Specifies the bucket owner's access for objects that another account uploads to\ntheir Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these\nobjects. This property allows you to give the bucket owner access to these objects. Valid values are `NONE`,\n`READ_ONLY`, and `FULL`. your CodeBuild service role must have the `s3:PutBucketAcl` permission. This permission\nallows CodeBuild to modify the access control list for the bucket.\n" }, "encryptionDisabled": { "type": "boolean", "description": "Whether to disable encrypting S3 logs. Defaults to `false`.\n" }, "location": { "type": "string", "description": "Name of the S3 bucket and the path prefix for S3 logs. Must be set if status is `ENABLED`,\notherwise it must be empty.\n" }, "status": { "type": "string", "description": "Current status of logs in S3 for a build project. Valid values: `ENABLED`, `DISABLED`. Defaults\nto `DISABLED`.\n" } }, "type": "object" }, "aws:codebuild/ProjectSecondaryArtifact:ProjectSecondaryArtifact": { "properties": { "artifactIdentifier": { "type": "string", "description": "Artifact identifier. Must be the same specified inside the AWS CodeBuild build\nspecification.\n" }, "bucketOwnerAccess": { "type": "string", "description": "Specifies the bucket owner's access for objects that another account uploads to\ntheir Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these\nobjects. This property allows you to give the bucket owner access to these objects. Valid values are `NONE`,\n`READ_ONLY`, and `FULL`. The CodeBuild service role must have the `s3:PutBucketAcl` permission. This permission allows\nCodeBuild to modify the access control list for the bucket.\n" }, "encryptionDisabled": { "type": "boolean", "description": "Whether to disable encrypting output artifacts. If `type` is set to `NO_ARTIFACTS`,\nthis value is ignored. Defaults to `false`.\n" }, "location": { "type": "string", "description": "Information about the build output artifact location. If `type` is set to `CODEPIPELINE` or\n`NO_ARTIFACTS`, this value is ignored if specified. If `type` is set to `S3`, this is the name of the output bucket.\nIf `path` is not specified, `location` can specify the path of the output artifact in the output bucket.\n" }, "name": { "type": "string", "description": "Name of the project. If `type` is set to `CODEPIPELINE` or `NO_ARTIFACTS`, this value is ignored\nif specified. If `type` is set to `S3`, this is the name of the output artifact object.\n" }, "namespaceType": { "type": "string", "description": "Namespace to use in storing build artifacts. If `type` is set to `CODEPIPELINE` or\n`NO_ARTIFACTS`, this value is ignored if specified. If `type` is set to `S3`, valid values are `BUILD_ID` or `NONE`.\n" }, "overrideArtifactName": { "type": "boolean", "description": "Whether a name specified in the build specification overrides the artifact name.\n" }, "packaging": { "type": "string", "description": "Type of build output artifact to create. If `type` is set to `CODEPIPELINE` or\n`NO_ARTIFACTS`, this value is ignored if specified. If `type` is set to `S3`, valid values are `NONE` or `ZIP`.\n" }, "path": { "type": "string", "description": "Along with `namespace_type` and `name`, the pattern that AWS CodeBuild uses to name and store the\noutput artifact. If `type` is set to `CODEPIPELINE` or `NO_ARTIFACTS`, this value is ignored if specified. If `type`\nis set to `S3`, this is the path to the output artifact.\n" }, "type": { "type": "string", "description": "Build output artifact's type. Valid values `CODEPIPELINE`, `NO_ARTIFACTS`, and `S3`.\n" } }, "type": "object", "required": [ "artifactIdentifier", "type" ] }, "aws:codebuild/ProjectSecondarySource:ProjectSecondarySource": { "properties": { "auth": { "$ref": "#/types/aws:codebuild/ProjectSecondarySourceAuth:ProjectSecondarySourceAuth", "description": "Information about the strategy CodeBuild should use when authenticating with the source code host.\nDetailed below.\n" }, "buildStatusConfig": { "$ref": "#/types/aws:codebuild/ProjectSecondarySourceBuildStatusConfig:ProjectSecondarySourceBuildStatusConfig", "description": "Configuration block that contains information that defines how the build project\nreports the build status to the source provider. This option is only used when the source provider is GitHub, GitHub\nEnterprise, GitLab, GitLab Self Managed, or Bitbucket. `build_status_config` blocks are documented below.\n" }, "buildspec": { "type": "string", "description": "The build spec declaration to use for this build project's related builds. This must be set\nwhen `type` is `NO_SOURCE`. It can either be a path to a file residing in the repository to be built or a local file\npath leveraging the `file()` built-in.\n" }, "gitCloneDepth": { "type": "integer", "description": "Truncate git history to this many commits. Use `0` for a `Full` checkout which you need\nto run commands like `git branch --show-current`.\nSee [AWS CodePipeline User Guide: Tutorial: Use full clone with a GitHub pipeline source](https://docs.aws.amazon.com/codepipeline/latest/userguide/tutorials-github-gitclone.html)\nfor details.\n" }, "gitSubmodulesConfig": { "$ref": "#/types/aws:codebuild/ProjectSecondarySourceGitSubmodulesConfig:ProjectSecondarySourceGitSubmodulesConfig", "description": "Configuration block. Detailed below.\n" }, "insecureSsl": { "type": "boolean", "description": "Ignore SSL warnings when connecting to source control.\n" }, "location": { "type": "string", "description": "Location of the source code from git or s3.\n" }, "reportBuildStatus": { "type": "boolean", "description": "Whether to report the status of a build's start and finish to your source provider.\nThis option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or\nBitbucket.\n" }, "sourceIdentifier": { "type": "string", "description": "An identifier for this project source. The identifier can only contain alphanumeric\ncharacters and underscores, and must be less than 128 characters in length.\n" }, "type": { "type": "string", "description": "Type of repository that contains the source code to be built. Valid values: `BITBUCKET`,\n`CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `GITHUB_ENTERPRISE`, `GITLAB`, `GITLAB_SELF_MANAGED`, `NO_SOURCE`, `S3`.\n" } }, "type": "object", "required": [ "sourceIdentifier", "type" ] }, "aws:codebuild/ProjectSecondarySourceAuth:ProjectSecondarySourceAuth": { "properties": { "resource": { "type": "string", "description": "The ARN of the resource to use for authentication. For type `CODECONNECTIONS` this should be\nan AWS CodeStar Connection. For type `SECRETS_MANAGER` this should be an AWS Secrets Manager secret.\n" }, "type": { "type": "string", "description": "The type of authentication AWS CodeBuild should perform. Valid values are `CODECONNECTIONS` and\n`SECRETS_MANAGER`.\n" } }, "type": "object", "required": [ "resource", "type" ] }, "aws:codebuild/ProjectSecondarySourceBuildStatusConfig:ProjectSecondarySourceBuildStatusConfig": { "properties": { "context": { "type": "string", "description": "Specifies the context of the build status CodeBuild sends to the source provider. The usage of\nthis parameter depends on the source provider.\n" }, "targetUrl": { "type": "string", "description": "Specifies the target url of the build status CodeBuild sends to the source provider. The\nusage of this parameter depends on the source provider.\n" } }, "type": "object" }, "aws:codebuild/ProjectSecondarySourceGitSubmodulesConfig:ProjectSecondarySourceGitSubmodulesConfig": { "properties": { "fetchSubmodules": { "type": "boolean", "description": "Whether to fetch Git submodules for the AWS CodeBuild build project.\n" } }, "type": "object", "required": [ "fetchSubmodules" ] }, "aws:codebuild/ProjectSecondarySourceVersion:ProjectSecondarySourceVersion": { "properties": { "sourceIdentifier": { "type": "string", "description": "An identifier for a source in the build project.\n" }, "sourceVersion": { "type": "string", "description": "The source version for the corresponding source identifier.\nSee [AWS docs](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ProjectSourceVersion.html#CodeBuild-Type-ProjectSourceVersion-sourceVersion)\nfor more details.\n" } }, "type": "object", "required": [ "sourceIdentifier", "sourceVersion" ] }, "aws:codebuild/ProjectSource:ProjectSource": { "properties": { "auth": { "$ref": "#/types/aws:codebuild/ProjectSourceAuth:ProjectSourceAuth", "description": "Information about the strategy CodeBuild should use when authenticating with the source code host.\nDetailed below.\n" }, "buildStatusConfig": { "$ref": "#/types/aws:codebuild/ProjectSourceBuildStatusConfig:ProjectSourceBuildStatusConfig", "description": "Configuration block that contains information that defines how the build project\nreports the build status to the source provider. This option is only used when the source provider is GitHub, GitHub\nEnterprise, GitLab, GitLab Self Managed, or Bitbucket. `build_status_config` blocks are documented below.\n" }, "buildspec": { "type": "string", "description": "Build specification to use for this build project's related builds. This must be set when\n`type` is `NO_SOURCE`. Also, if a non-default buildspec file name or file path aside from the root is used, it must be\nspecified.\n" }, "gitCloneDepth": { "type": "integer", "description": "Truncate git history to this many commits. Use `0` for a `Full` checkout which you need\nto run commands like `git branch --show-current`.\nSee [AWS CodePipeline User Guide: Tutorial: Use full clone with a GitHub pipeline source](https://docs.aws.amazon.com/codepipeline/latest/userguide/tutorials-github-gitclone.html)\nfor details.\n" }, "gitSubmodulesConfig": { "$ref": "#/types/aws:codebuild/ProjectSourceGitSubmodulesConfig:ProjectSourceGitSubmodulesConfig", "description": "Configuration block. Detailed below.\n" }, "insecureSsl": { "type": "boolean", "description": "Ignore SSL warnings when connecting to source control.\n" }, "location": { "type": "string", "description": "Location of the source code from git or s3.\n" }, "reportBuildStatus": { "type": "boolean", "description": "Whether to report the status of a build's start and finish to your source provider.\nThis option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or\nBitbucket.\n" }, "type": { "type": "string", "description": "Type of repository that contains the source code to be built. Valid values: `BITBUCKET`,\n`CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `GITHUB_ENTERPRISE`, `GITLAB`, `GITLAB_SELF_MANAGED`, `NO_SOURCE`, `S3`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:codebuild/ProjectSourceAuth:ProjectSourceAuth": { "properties": { "resource": { "type": "string", "description": "The ARN of the resource to use for authentication. For type `CODECONNECTIONS` this should be\nan AWS CodeStar Connection. For type `SECRETS_MANAGER` this should be an AWS Secrets Manager secret.\n" }, "type": { "type": "string", "description": "The type of authentication AWS CodeBuild should perform. Valid values are `CODECONNECTIONS` and\n`SECRETS_MANAGER`.\n" } }, "type": "object", "required": [ "resource", "type" ] }, "aws:codebuild/ProjectSourceBuildStatusConfig:ProjectSourceBuildStatusConfig": { "properties": { "context": { "type": "string", "description": "Specifies the context of the build status CodeBuild sends to the source provider. The usage of\nthis parameter depends on the source provider.\n" }, "targetUrl": { "type": "string", "description": "Specifies the target url of the build status CodeBuild sends to the source provider. The\nusage of this parameter depends on the source provider.\n" } }, "type": "object" }, "aws:codebuild/ProjectSourceGitSubmodulesConfig:ProjectSourceGitSubmodulesConfig": { "properties": { "fetchSubmodules": { "type": "boolean", "description": "Whether to fetch Git submodules for the AWS CodeBuild build project.\n" } }, "type": "object", "required": [ "fetchSubmodules" ] }, "aws:codebuild/ProjectVpcConfig:ProjectVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group IDs to assign to running builds.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "Subnet IDs within which to run builds.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC within which to run builds.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnets", "vpcId" ] }, "aws:codebuild/ReportGroupExportConfig:ReportGroupExportConfig": { "properties": { "s3Destination": { "$ref": "#/types/aws:codebuild/ReportGroupExportConfigS3Destination:ReportGroupExportConfigS3Destination", "description": "contains information about the S3 bucket where the run of a report is exported. see S3 Destination documented below.\n" }, "type": { "type": "string", "description": "The export configuration type. Valid values are `S3` and `NO_EXPORT`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:codebuild/ReportGroupExportConfigS3Destination:ReportGroupExportConfigS3Destination": { "properties": { "bucket": { "type": "string", "description": "The name of the S3 bucket where the raw data of a report are exported.\n" }, "encryptionDisabled": { "type": "boolean", "description": "A boolean value that specifies if the results of a report are encrypted.\n**Note: the API does not currently allow setting encryption as disabled**\n" }, "encryptionKey": { "type": "string", "description": "The encryption key for the report's encrypted raw data. The KMS key ARN.\n" }, "packaging": { "type": "string", "description": "The type of build output artifact to create. Valid values are: `NONE` (default) and `ZIP`.\n" }, "path": { "type": "string", "description": "The path to the exported report's raw data results.\n" } }, "type": "object", "required": [ "bucket", "encryptionKey" ] }, "aws:codebuild/WebhookFilterGroup:WebhookFilterGroup": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:codebuild/WebhookFilterGroupFilter:WebhookFilterGroupFilter" }, "description": "A webhook filter for the group. Filter blocks are documented below.\n" } }, "type": "object" }, "aws:codebuild/WebhookFilterGroupFilter:WebhookFilterGroupFilter": { "properties": { "excludeMatchedPattern": { "type": "boolean", "description": "If set to `true`, the specified filter does *not* trigger a build. Defaults to `false`.\n" }, "pattern": { "type": "string", "description": "For a filter that uses `EVENT` type, a comma-separated string that specifies one event: `PUSH`, `PULL_REQUEST_CREATED`, `PULL_REQUEST_UPDATED`, `PULL_REQUEST_REOPENED`. `PULL_REQUEST_MERGED`, `WORKFLOW_JOB_QUEUED` works with GitHub \u0026 GitHub Enterprise only. For a filter that uses any of the other filter types, a regular expression.\n" }, "type": { "type": "string", "description": "The webhook filter group's type. Valid values for this parameter are: `EVENT`, `BASE_REF`, `HEAD_REF`, `ACTOR_ACCOUNT_ID`, `FILE_PATH`, `COMMIT_MESSAGE`, `WORKFLOW_NAME`, `TAG_NAME`, `RELEASE_NAME`. At least one filter group must specify `EVENT` as its type.\n" } }, "type": "object", "required": [ "pattern", "type" ] }, "aws:codebuild/WebhookScopeConfiguration:WebhookScopeConfiguration": { "properties": { "domain": { "type": "string", "description": "The domain of the GitHub Enterprise organization. Required if your project's source type is GITHUB_ENTERPRISE.\n" }, "name": { "type": "string", "description": "The name of either the enterprise or organization.\n" }, "scope": { "type": "string", "description": "The type of scope for a GitHub webhook. Valid values for this parameter are: `GITHUB_ORGANIZATION`, `GITHUB_GLOBAL`.\n" } }, "type": "object", "required": [ "name", "scope" ] }, "aws:codebuild/getFleetComputeConfiguration:getFleetComputeConfiguration": { "properties": { "disk": { "type": "integer", "description": "Amount of disk space of the instance type included in the fleet.\n" }, "machineType": { "type": "string", "description": "Machine type of the instance type included in the fleet.\n" }, "memory": { "type": "integer", "description": "Amount of memory of the instance type included in the fleet.\n" }, "vcpu": { "type": "integer", "description": "Number of vCPUs of the instance type included in the fleet.\n" } }, "type": "object", "required": [ "disk", "machineType", "memory", "vcpu" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codebuild/getFleetScalingConfiguration:getFleetScalingConfiguration": { "properties": { "desiredCapacity": { "type": "integer", "description": "The desired number of instances in the fleet when auto-scaling.\n" }, "maxCapacity": { "type": "integer", "description": "The maximum number of instances in the fleet when auto-scaling.\n" }, "scalingType": { "type": "string", "description": "The scaling type for a compute fleet.\n" }, "targetTrackingScalingConfigs": { "type": "array", "items": { "$ref": "#/types/aws:codebuild/getFleetScalingConfigurationTargetTrackingScalingConfig:getFleetScalingConfigurationTargetTrackingScalingConfig" }, "description": "Nested attribute containing information about thresholds when new instance is auto-scaled into the compute fleet.\n" } }, "type": "object", "required": [ "desiredCapacity", "maxCapacity", "scalingType", "targetTrackingScalingConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codebuild/getFleetScalingConfigurationTargetTrackingScalingConfig:getFleetScalingConfigurationTargetTrackingScalingConfig": { "properties": { "metricType": { "type": "string", "description": "The metric type to determine auto-scaling.\n" }, "targetValue": { "type": "number", "description": "The value of metric_type when to start scaling.\n" } }, "type": "object", "required": [ "metricType", "targetValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codebuild/getFleetStatus:getFleetStatus": { "properties": { "context": { "type": "string", "description": "Additional information about a compute fleet.\n" }, "message": { "type": "string", "description": "Message associated with the status of a compute fleet.\n" }, "statusCode": { "type": "string", "description": "Status code of the compute fleet.\n" } }, "type": "object", "required": [ "context", "message", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codebuild/getFleetVpcConfig:getFleetVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of one or more security groups IDs in your Amazon VPC.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "A list of one or more subnet IDs in your Amazon VPC.\n" }, "vpcId": { "type": "string", "description": "The ID of the Amazon VPC.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnets", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codecatalyst/DevEnvironmentIdes:DevEnvironmentIdes": { "properties": { "name": { "type": "string", "description": "The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.\n" }, "runtime": { "type": "string", "description": "A link to the IDE runtime image. This parameter is not required if the name is VSCode. Values of the runtime can be for example public.ecr.aws/jetbrains/py,public.ecr.aws/jetbrains/go\n" } }, "type": "object" }, "aws:codecatalyst/DevEnvironmentPersistentStorage:DevEnvironmentPersistentStorage": { "properties": { "size": { "type": "integer", "description": "The size of the persistent storage in gigabytes (specifically GiB). Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.\n" } }, "type": "object", "required": [ "size" ] }, "aws:codecatalyst/DevEnvironmentRepository:DevEnvironmentRepository": { "properties": { "branchName": { "type": "string", "description": "The name of the branch in a source repository.\n\npersistent storage (` persistent_storage`) supports the following:\n" }, "repositoryName": { "type": "string", "description": "The name of the source repository.\n" } }, "type": "object", "required": [ "repositoryName" ] }, "aws:codecatalyst/getDevEnvironmentIde:getDevEnvironmentIde": { "properties": { "name": { "type": "string" }, "runtime": { "type": "string" } }, "type": "object", "required": [ "name", "runtime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codecatalyst/getDevEnvironmentPersistentStorage:getDevEnvironmentPersistentStorage": { "properties": { "size": { "type": "integer" } }, "type": "object", "required": [ "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codecatalyst/getDevEnvironmentRepository:getDevEnvironmentRepository": { "properties": { "branchName": { "type": "string" }, "repositoryName": { "type": "string" } }, "type": "object", "required": [ "branchName", "repositoryName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codecommit/TriggerTrigger:TriggerTrigger": { "properties": { "branches": { "type": "array", "items": { "type": "string" }, "description": "The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches.\n", "willReplaceOnChanges": true }, "customData": { "type": "string", "description": "Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.\n", "willReplaceOnChanges": true }, "destinationArn": { "type": "string", "description": "The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon Simple Notification Service (SNS).\n", "willReplaceOnChanges": true }, "events": { "type": "array", "items": { "type": "string" }, "description": "The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS). If no events are specified, the trigger will run for all repository events. Event types include: `all`, `updateReference`, `createReference`, `deleteReference`.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the trigger.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "destinationArn", "events", "name" ] }, "aws:codeconnections/ConnectionTimeouts:ConnectionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:codeconnections/HostTimeouts:HostTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:codeconnections/HostVpcConfiguration:HostVpcConfiguration": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.\n" }, "tlsCertificate": { "type": "string", "description": "The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.\n" }, "vpcId": { "type": "string", "description": "The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds", "vpcId" ] }, "aws:codedeploy/DeploymentConfigMinimumHealthyHosts:DeploymentConfigMinimumHealthyHosts": { "properties": { "type": { "type": "string", "description": "The type can either be `FLEET_PERCENT` or `HOST_COUNT`.\n", "willReplaceOnChanges": true }, "value": { "type": "integer", "description": "The value when the type is `FLEET_PERCENT` represents the minimum number of healthy instances as\na percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the\ndeployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.\nWhen the type is `HOST_COUNT`, the value represents the minimum number of healthy instances as an absolute value.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentConfigTrafficRoutingConfig:DeploymentConfigTrafficRoutingConfig": { "properties": { "timeBasedCanary": { "$ref": "#/types/aws:codedeploy/DeploymentConfigTrafficRoutingConfigTimeBasedCanary:DeploymentConfigTrafficRoutingConfigTimeBasedCanary", "description": "The time based canary configuration information. If `type` is `TimeBasedLinear`, use `time_based_linear` instead.\n", "willReplaceOnChanges": true }, "timeBasedLinear": { "$ref": "#/types/aws:codedeploy/DeploymentConfigTrafficRoutingConfigTimeBasedLinear:DeploymentConfigTrafficRoutingConfigTimeBasedLinear", "description": "The time based linear configuration information. If `type` is `TimeBasedCanary`, use `time_based_canary` instead.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of traffic routing config. One of `TimeBasedCanary`, `TimeBasedLinear`, `AllAtOnce`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentConfigTrafficRoutingConfigTimeBasedCanary:DeploymentConfigTrafficRoutingConfigTimeBasedCanary": { "properties": { "interval": { "type": "integer", "description": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment.\n", "willReplaceOnChanges": true }, "percentage": { "type": "integer", "description": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentConfigTrafficRoutingConfigTimeBasedLinear:DeploymentConfigTrafficRoutingConfigTimeBasedLinear": { "properties": { "interval": { "type": "integer", "description": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment.\n", "willReplaceOnChanges": true }, "percentage": { "type": "integer", "description": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentConfigZonalConfig: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. If you don't specify a value for `first_zone_monitor_duration_in_seconds`, then CodeDeploy uses the `monitor_duration_in_seconds` value for the first Availability Zone.\n", "willReplaceOnChanges": true }, "minimumHealthyHostsPerZone": { "$ref": "#/types/aws:codedeploy/DeploymentConfigZonalConfigMinimumHealthyHostsPerZone:DeploymentConfigZonalConfigMinimumHealthyHostsPerZone", "description": "The number or percentage of instances that must remain available per Availability Zone during a deployment. If you don't specify a value under `minimum_healthy_hosts_per_zone`, then CodeDeploy uses a default value of 0 percent. This block is more documented below.\n", "willReplaceOnChanges": true }, "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. If you don't specify a `monitor_duration_in_seconds`, CodeDeploy starts deploying to the next Availability Zone immediately.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentConfigZonalConfigMinimumHealthyHostsPerZone:DeploymentConfigZonalConfigMinimumHealthyHostsPerZone": { "properties": { "type": { "type": "string", "description": "The type can either be `FLEET_PERCENT` or `HOST_COUNT`.\n", "willReplaceOnChanges": true }, "value": { "type": "integer", "description": "The value when the type is `FLEET_PERCENT` represents the minimum number of healthy instances as a percentage of the total number of instances in the Availability Zone during a deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances. When the type is `HOST_COUNT`, the value represents the minimum number of healthy instances in the Availability Zone as an absolute value.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codedeploy/DeploymentGroupAlarmConfiguration:DeploymentGroupAlarmConfiguration": { "properties": { "alarms": { "type": "array", "items": { "type": "string" }, "description": "A list of alarms configured for the deployment group.\n" }, "enabled": { "type": "boolean", "description": "Indicates whether the alarm configuration is enabled. This option is useful when you want to temporarily deactivate alarm monitoring for a deployment group without having to add the same alarms again later.\n" }, "ignorePollAlarmFailure": { "type": "boolean", "description": "Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from CloudWatch. The default value is `false`.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupAutoRollbackConfiguration:DeploymentGroupAutoRollbackConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Indicates whether a defined automatic rollback configuration is currently enabled for this Deployment Group. If you enable automatic rollback, you must specify at least one event type.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "The event type or types that trigger a rollback. Supported types are `DEPLOYMENT_FAILURE`, `DEPLOYMENT_STOP_ON_ALARM` and `DEPLOYMENT_STOP_ON_REQUEST`.\n\n_Only one `auto_rollback_configuration` is allowed_.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfig:DeploymentGroupBlueGreenDeploymentConfig": { "properties": { "deploymentReadyOption": { "$ref": "#/types/aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigDeploymentReadyOption:DeploymentGroupBlueGreenDeploymentConfigDeploymentReadyOption", "description": "Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment (documented below).\n" }, "greenFleetProvisioningOption": { "$ref": "#/types/aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigGreenFleetProvisioningOption:DeploymentGroupBlueGreenDeploymentConfigGreenFleetProvisioningOption", "description": "Information about how instances are provisioned for a replacement environment in a blue/green deployment (documented below).\n" }, "terminateBlueInstancesOnDeploymentSuccess": { "$ref": "#/types/aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigTerminateBlueInstancesOnDeploymentSuccess:DeploymentGroupBlueGreenDeploymentConfigTerminateBlueInstancesOnDeploymentSuccess", "description": "Information about whether to terminate instances in the original fleet during a blue/green deployment (documented below).\n\n_Only one `blue_green_deployment_config` is allowed_.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "greenFleetProvisioningOption" ] } } }, "aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigDeploymentReadyOption:DeploymentGroupBlueGreenDeploymentConfigDeploymentReadyOption": { "properties": { "actionOnTimeout": { "type": "string", "description": "When to reroute traffic from an original environment to a replacement environment in a blue/green deployment.\n* `CONTINUE_DEPLOYMENT`: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.\n* `STOP_DEPLOYMENT`: Do not register new instances with load balancer unless traffic is rerouted manually. If traffic is not rerouted manually before the end of the specified wait period, the deployment status is changed to Stopped.\n" }, "waitTimeInMinutes": { "type": "integer", "description": "The number of minutes to wait before the status of a blue/green deployment changed to Stopped if rerouting is not started manually. Applies only to the `STOP_DEPLOYMENT` option for `action_on_timeout`.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigGreenFleetProvisioningOption:DeploymentGroupBlueGreenDeploymentConfigGreenFleetProvisioningOption": { "properties": { "action": { "type": "string", "description": "The method used to add instances to a replacement environment.\n* `DISCOVER_EXISTING`: Use instances that already exist or will be created manually.\n* `COPY_AUTO_SCALING_GROUP`: Use settings from a specified **Auto Scaling** group to define and create instances in a new Auto Scaling group. _Exactly one Auto Scaling group must be specified_ when selecting `COPY_AUTO_SCALING_GROUP`. Use `autoscaling_groups` to specify the Auto Scaling group.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupBlueGreenDeploymentConfigTerminateBlueInstancesOnDeploymentSuccess:DeploymentGroupBlueGreenDeploymentConfigTerminateBlueInstancesOnDeploymentSuccess": { "properties": { "action": { "type": "string", "description": "The action to take on instances in the original environment after a successful blue/green deployment.\n* `TERMINATE`: Instances are terminated after a specified wait time.\n* `KEEP_ALIVE`: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.\n" }, "terminationWaitTimeInMinutes": { "type": "integer", "description": "The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupDeploymentStyle:DeploymentGroupDeploymentStyle": { "properties": { "deploymentOption": { "type": "string", "description": "Indicates whether to route deployment traffic behind a load balancer. Valid Values are `WITH_TRAFFIC_CONTROL` or `WITHOUT_TRAFFIC_CONTROL`. Default is `WITHOUT_TRAFFIC_CONTROL`.\n" }, "deploymentType": { "type": "string", "description": "Indicates whether to run an in-place deployment or a blue/green deployment. Valid Values are `IN_PLACE` or `BLUE_GREEN`. Default is `IN_PLACE`.\n\n_Only one `deployment_style` is allowed_.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupEc2TagFilter:DeploymentGroupEc2TagFilter": { "properties": { "key": { "type": "string", "description": "The key of the tag filter.\n" }, "type": { "type": "string", "description": "The type of the tag filter, either `KEY_ONLY`, `VALUE_ONLY`, or `KEY_AND_VALUE`.\n" }, "value": { "type": "string", "description": "The value of the tag filter.\n\nMultiple occurrences of `ec2_tag_filter` are allowed, where any instance that matches to at least one of the tag filters is selected.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupEc2TagSet:DeploymentGroupEc2TagSet": { "properties": { "ec2TagFilters": { "type": "array", "items": { "$ref": "#/types/aws:codedeploy/DeploymentGroupEc2TagSetEc2TagFilter:DeploymentGroupEc2TagSetEc2TagFilter" }, "description": "Tag filters associated with the deployment group. See the AWS docs for details.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupEc2TagSetEc2TagFilter:DeploymentGroupEc2TagSetEc2TagFilter": { "properties": { "key": { "type": "string", "description": "The key of the tag filter.\n" }, "type": { "type": "string", "description": "The type of the tag filter, either `KEY_ONLY`, `VALUE_ONLY`, or `KEY_AND_VALUE`.\n" }, "value": { "type": "string", "description": "The value of the tag filter.\n\nMultiple occurrences of `ec2_tag_filter` are allowed, where any instance that matches to at least one of the tag filters is selected.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupEcsService:DeploymentGroupEcsService": { "properties": { "clusterName": { "type": "string", "description": "The name of the ECS cluster.\n" }, "serviceName": { "type": "string", "description": "The name of the ECS service.\n" } }, "type": "object", "required": [ "clusterName", "serviceName" ] }, "aws:codedeploy/DeploymentGroupLoadBalancerInfo:DeploymentGroupLoadBalancerInfo": { "properties": { "elbInfos": { "type": "array", "items": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoElbInfo:DeploymentGroupLoadBalancerInfoElbInfo" }, "description": "The Classic Elastic Load Balancer to use in a deployment. Conflicts with `target_group_info` and `target_group_pair_info`.\n" }, "targetGroupInfos": { "type": "array", "items": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupInfo:DeploymentGroupLoadBalancerInfoTargetGroupInfo" }, "description": "The (Application/Network Load Balancer) target group to use in a deployment. Conflicts with `elb_info` and `target_group_pair_info`.\n" }, "targetGroupPairInfo": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfo:DeploymentGroupLoadBalancerInfoTargetGroupPairInfo", "description": "The (Application/Network Load Balancer) target group pair to use in a deployment. Conflicts with `elb_info` and `target_group_info`.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoElbInfo:DeploymentGroupLoadBalancerInfoElbInfo": { "properties": { "name": { "type": "string", "description": "The name of the load balancer that will be 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 completes.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupInfo:DeploymentGroupLoadBalancerInfoTargetGroupInfo": { "properties": { "name": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfo:DeploymentGroupLoadBalancerInfoTargetGroupPairInfo": { "properties": { "prodTrafficRoute": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoProdTrafficRoute:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoProdTrafficRoute", "description": "Configuration block for the production traffic route (documented below).\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTargetGroup:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTargetGroup" }, "description": "Configuration blocks for a target group within a target group pair (documented below).\n" }, "testTrafficRoute": { "$ref": "#/types/aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTestTrafficRoute:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTestTrafficRoute", "description": "Configuration block for the test traffic route (documented below).\n" } }, "type": "object", "required": [ "prodTrafficRoute", "targetGroups" ] }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoProdTrafficRoute:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoProdTrafficRoute": { "properties": { "listenerArns": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon Resource Names (ARNs) of the load balancer listeners. Must contain exactly one listener ARN.\n" } }, "type": "object", "required": [ "listenerArns" ] }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTargetGroup:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTargetGroup": { "properties": { "name": { "type": "string", "description": "Name of the target group.\n" } }, "type": "object", "required": [ "name" ] }, "aws:codedeploy/DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTestTrafficRoute:DeploymentGroupLoadBalancerInfoTargetGroupPairInfoTestTrafficRoute": { "properties": { "listenerArns": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon Resource Names (ARNs) of the load balancer listeners.\n" } }, "type": "object", "required": [ "listenerArns" ] }, "aws:codedeploy/DeploymentGroupOnPremisesInstanceTagFilter:DeploymentGroupOnPremisesInstanceTagFilter": { "properties": { "key": { "type": "string", "description": "The key of the tag filter.\n" }, "type": { "type": "string", "description": "The type of the tag filter, either `KEY_ONLY`, `VALUE_ONLY`, or `KEY_AND_VALUE`.\n" }, "value": { "type": "string", "description": "The value of the tag filter.\n" } }, "type": "object" }, "aws:codedeploy/DeploymentGroupTriggerConfiguration:DeploymentGroupTriggerConfiguration": { "properties": { "triggerEvents": { "type": "array", "items": { "type": "string" }, "description": "The event type or types for which notifications are triggered. Some values that are supported: `DeploymentStart`, `DeploymentSuccess`, `DeploymentFailure`, `DeploymentStop`, `DeploymentRollback`, `InstanceStart`, `InstanceSuccess`, `InstanceFailure`. See [the CodeDeploy documentation](http://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-sns-event-notifications-create-trigger.html) for all possible values.\n" }, "triggerName": { "type": "string", "description": "The name of the notification trigger.\n" }, "triggerTargetArn": { "type": "string", "description": "The ARN of the SNS topic through which notifications are sent.\n" } }, "type": "object", "required": [ "triggerEvents", "triggerName", "triggerTargetArn" ] }, "aws:codeguruprofiler/ProfilingGroupAgentOrchestrationConfig:ProfilingGroupAgentOrchestrationConfig": { "properties": { "profilingEnabled": { "type": "boolean", "description": "(Required) Boolean that specifies whether the profiling agent collects profiling data or\n" } }, "type": "object", "required": [ "profilingEnabled" ] }, "aws:codeguruprofiler/getProfilingGroupAgentOrchestrationConfig:getProfilingGroupAgentOrchestrationConfig": { "properties": { "profilingEnabled": { "type": "boolean" } }, "type": "object", "required": [ "profilingEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codeguruprofiler/getProfilingGroupProfilingStatus:getProfilingGroupProfilingStatus": { "properties": { "latestAgentOrchestratedAt": { "type": "string" }, "latestAgentProfileReportedAt": { "type": "string" }, "latestAggregatedProfiles": { "type": "array", "items": { "$ref": "#/types/aws:codeguruprofiler/getProfilingGroupProfilingStatusLatestAggregatedProfile:getProfilingGroupProfilingStatusLatestAggregatedProfile" } } }, "type": "object", "required": [ "latestAgentOrchestratedAt", "latestAgentProfileReportedAt", "latestAggregatedProfiles" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codeguruprofiler/getProfilingGroupProfilingStatusLatestAggregatedProfile:getProfilingGroupProfilingStatusLatestAggregatedProfile": { "properties": { "period": { "type": "string" }, "start": { "type": "string" } }, "type": "object", "required": [ "period", "start" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:codegurureviewer/RepositoryAssociationKmsKeyDetails:RepositoryAssociationKmsKeyDetails": { "properties": { "encryptionOption": { "type": "string", "description": "The encryption option for a repository association. It is either owned by AWS Key Management Service (KMS) (`AWS_OWNED_CMK`) or customer managed (`CUSTOMER_MANAGED_CMK`).\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The ID of the AWS KMS key that is associated with a repository association.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codegurureviewer/RepositoryAssociationRepository:RepositoryAssociationRepository": { "properties": { "bitbucket": { "$ref": "#/types/aws:codegurureviewer/RepositoryAssociationRepositoryBitbucket:RepositoryAssociationRepositoryBitbucket", "willReplaceOnChanges": true }, "codecommit": { "$ref": "#/types/aws:codegurureviewer/RepositoryAssociationRepositoryCodecommit:RepositoryAssociationRepositoryCodecommit", "willReplaceOnChanges": true }, "githubEnterpriseServer": { "$ref": "#/types/aws:codegurureviewer/RepositoryAssociationRepositoryGithubEnterpriseServer:RepositoryAssociationRepositoryGithubEnterpriseServer", "willReplaceOnChanges": true }, "s3Bucket": { "$ref": "#/types/aws:codegurureviewer/RepositoryAssociationRepositoryS3Bucket:RepositoryAssociationRepositoryS3Bucket", "willReplaceOnChanges": true } }, "type": "object" }, "aws:codegurureviewer/RepositoryAssociationRepositoryBitbucket:RepositoryAssociationRepositoryBitbucket": { "properties": { "connectionArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.\n" }, "name": { "type": "string", "description": "The name of the third party source repository.\n" }, "owner": { "type": "string", "description": "The username for the account that owns the repository.\n" } }, "type": "object", "required": [ "connectionArn", "name", "owner" ] }, "aws:codegurureviewer/RepositoryAssociationRepositoryCodecommit:RepositoryAssociationRepositoryCodecommit": { "properties": { "name": { "type": "string", "description": "The name of the AWS CodeCommit repository.\n" } }, "type": "object", "required": [ "name" ] }, "aws:codegurureviewer/RepositoryAssociationRepositoryGithubEnterpriseServer:RepositoryAssociationRepositoryGithubEnterpriseServer": { "properties": { "connectionArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.\n" }, "name": { "type": "string", "description": "The name of the third party source repository.\n" }, "owner": { "type": "string", "description": "The username for the account that owns the repository.\n" } }, "type": "object", "required": [ "connectionArn", "name", "owner" ] }, "aws:codegurureviewer/RepositoryAssociationRepositoryS3Bucket:RepositoryAssociationRepositoryS3Bucket": { "properties": { "bucketName": { "type": "string", "description": "The name of the S3 bucket used for associating a new S3 repository. Note: The name must begin with `codeguru-reviewer-`.\n" }, "name": { "type": "string", "description": "The name of the repository in the S3 bucket.\n" } }, "type": "object", "required": [ "bucketName", "name" ] }, "aws:codegurureviewer/RepositoryAssociationS3RepositoryDetail:RepositoryAssociationS3RepositoryDetail": { "properties": { "bucketName": { "type": "string", "description": "The name of the S3 bucket used for associating a new S3 repository. Note: The name must begin with `codeguru-reviewer-`.\n" }, "codeArtifacts": { "type": "array", "items": { "$ref": "#/types/aws:codegurureviewer/RepositoryAssociationS3RepositoryDetailCodeArtifact:RepositoryAssociationS3RepositoryDetailCodeArtifact" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucketName", "codeArtifacts" ] } } }, "aws:codegurureviewer/RepositoryAssociationS3RepositoryDetailCodeArtifact:RepositoryAssociationS3RepositoryDetailCodeArtifact": { "properties": { "buildArtifactsObjectKey": { "type": "string" }, "sourceCodeArtifactsObjectKey": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "buildArtifactsObjectKey", "sourceCodeArtifactsObjectKey" ] } } }, "aws:codepipeline/CustomActionTypeConfigurationProperty:CustomActionTypeConfigurationProperty": { "properties": { "description": { "type": "string", "description": "The description of the action configuration property.\n" }, "key": { "type": "boolean", "description": "Whether the configuration property is a key.\n" }, "name": { "type": "string", "description": "The name of the action configuration property.\n" }, "queryable": { "type": "boolean", "description": "Indicates that the property will be used in conjunction with PollForJobs.\n" }, "required": { "type": "boolean", "description": "Whether the configuration property is a required value.\n" }, "secret": { "type": "boolean", "description": "Whether the configuration property is secret.\n" }, "type": { "type": "string", "description": "The type of the configuration property. Valid values: `String`, `Number`, `Boolean`\n" } }, "type": "object", "required": [ "key", "name", "required", "secret" ] }, "aws:codepipeline/CustomActionTypeInputArtifactDetails:CustomActionTypeInputArtifactDetails": { "properties": { "maximumCount": { "type": "integer", "description": "The maximum number of artifacts allowed for the action type. Min: 0, Max: 5\n" }, "minimumCount": { "type": "integer", "description": "The minimum number of artifacts allowed for the action type. Min: 0, Max: 5\n" } }, "type": "object", "required": [ "maximumCount", "minimumCount" ] }, "aws:codepipeline/CustomActionTypeOutputArtifactDetails:CustomActionTypeOutputArtifactDetails": { "properties": { "maximumCount": { "type": "integer", "description": "The maximum number of artifacts allowed for the action type. Min: 0, Max: 5\n" }, "minimumCount": { "type": "integer", "description": "The minimum number of artifacts allowed for the action type. Min: 0, Max: 5\n" } }, "type": "object", "required": [ "maximumCount", "minimumCount" ] }, "aws:codepipeline/CustomActionTypeSettings:CustomActionTypeSettings": { "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.\n" }, "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.\n" }, "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.\n" }, "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.\n" } }, "type": "object" }, "aws:codepipeline/PipelineArtifactStore:PipelineArtifactStore": { "properties": { "encryptionKey": { "$ref": "#/types/aws:codepipeline/PipelineArtifactStoreEncryptionKey:PipelineArtifactStoreEncryptionKey", "description": "The encryption key block AWS CodePipeline uses to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If you don't specify a key, AWS CodePipeline uses the default key for Amazon Simple Storage Service (Amazon S3). An `encryption_key` block is documented below.\n" }, "location": { "type": "string", "description": "The location where AWS CodePipeline stores artifacts for a pipeline; currently only `S3` is supported.\n" }, "region": { "type": "string", "description": "The region where the artifact store is located. Required for a cross-region CodePipeline, do not provide for a single-region CodePipeline.\n" }, "type": { "type": "string", "description": "The type of the artifact store, such as Amazon S3\n" } }, "type": "object", "required": [ "location", "type" ] }, "aws:codepipeline/PipelineArtifactStoreEncryptionKey:PipelineArtifactStoreEncryptionKey": { "properties": { "id": { "type": "string", "description": "The KMS key ARN or ID\n" }, "type": { "type": "string", "description": "The type of key; currently only `KMS` is supported\n" } }, "type": "object", "required": [ "id", "type" ] }, "aws:codepipeline/PipelineStage:PipelineStage": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineStageAction:PipelineStageAction" }, "description": "The action(s) to include in the stage. Defined as an `action` block below\n" }, "beforeEntry": { "$ref": "#/types/aws:codepipeline/PipelineStageBeforeEntry:PipelineStageBeforeEntry", "description": "The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.\n" }, "name": { "type": "string", "description": "The name of the stage.\n" }, "onFailure": { "$ref": "#/types/aws:codepipeline/PipelineStageOnFailure:PipelineStageOnFailure", "description": "The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.\n" }, "onSuccess": { "$ref": "#/types/aws:codepipeline/PipelineStageOnSuccess:PipelineStageOnSuccess", "description": "The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.\n" } }, "type": "object", "required": [ "actions", "name" ] }, "aws:codepipeline/PipelineStageAction:PipelineStageAction": { "properties": { "category": { "type": "string", "description": "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Possible values are `Approval`, `Build`, `Deploy`, `Invoke`, `Source` and `Test`.\n" }, "configuration": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of the action declaration's configuration. Configurations options for action types and providers can be found in the [Pipeline Structure Reference](http://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) and [Action Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) documentation. Note: The `DetectChanges` parameter (optional, default value is true) in the `configuration` section causes CodePipeline to automatically start your pipeline upon new commits. Please refer to AWS Documentation for more details: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config.\n" }, "inputArtifacts": { "type": "array", "items": { "type": "string" }, "description": "A list of artifact names to be worked on.\n" }, "name": { "type": "string", "description": "The action declaration's name.\n" }, "namespace": { "type": "string", "description": "The namespace all output variables will be accessed from.\n" }, "outputArtifacts": { "type": "array", "items": { "type": "string" }, "description": "A list of artifact names to output. Output artifact names must be unique within a pipeline.\n" }, "owner": { "type": "string", "description": "The creator of the action being called. Possible values are `AWS`, `Custom` and `ThirdParty`.\n" }, "provider": { "type": "string", "description": "The provider of the service being called by the action. Valid providers are determined by the action category. Provider names are listed in the [Action Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) documentation.\n" }, "region": { "type": "string", "description": "The region in which to run the action.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.\n" }, "runOrder": { "type": "integer", "description": "The order in which actions are run.\n" }, "timeoutInMinutes": { "type": "integer", "description": "The action timeout for the rule.\n" }, "version": { "type": "string", "description": "A string that identifies the action type.\n" } }, "type": "object", "required": [ "category", "name", "owner", "provider", "version" ], "language": { "nodejs": { "requiredOutputs": [ "category", "name", "owner", "provider", "region", "runOrder", "version" ] } } }, "aws:codepipeline/PipelineStageBeforeEntry:PipelineStageBeforeEntry": { "properties": { "condition": { "$ref": "#/types/aws:codepipeline/PipelineStageBeforeEntryCondition:PipelineStageBeforeEntryCondition", "description": "The conditions that are configured as entry condition. Defined as a `condition` block below.\n" } }, "type": "object", "required": [ "condition" ] }, "aws:codepipeline/PipelineStageBeforeEntryCondition:PipelineStageBeforeEntryCondition": { "properties": { "result": { "type": "string", "description": "The action to be done when the condition is met. For example, rolling back an execution for a failure condition. Possible values are `ROLLBACK`, `FAIL`, `RETRY` and `SKIP`.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineStageBeforeEntryConditionRule:PipelineStageBeforeEntryConditionRule" }, "description": "The rules that make up the condition. Defined as a `rule` block below.\n" } }, "type": "object", "required": [ "rules" ] }, "aws:codepipeline/PipelineStageBeforeEntryConditionRule:PipelineStageBeforeEntryConditionRule": { "properties": { "commands": { "type": "array", "items": { "type": "string" }, "description": "The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats.\n" }, "configuration": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The action configuration fields for the rule. Configurations options for rule types and providers can be found in the [Rule structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "inputArtifacts": { "type": "array", "items": { "type": "string" }, "description": "The list of the input artifacts fields for the rule, such as specifying an input file for the rule.\n" }, "name": { "type": "string", "description": "The name of the rule that is created for the condition, such as `VariableCheck`.\n" }, "region": { "type": "string", "description": "The Region for the condition associated with the rule.\n" }, "roleArn": { "type": "string", "description": "The pipeline role ARN associated with the rule.\n" }, "ruleTypeId": { "$ref": "#/types/aws:codepipeline/PipelineStageBeforeEntryConditionRuleRuleTypeId:PipelineStageBeforeEntryConditionRuleRuleTypeId", "description": "The ID for the rule type, which is made up of the combined values for `category`, `owner`, `provider`, and `version`. Defined as an `rule_type_id` block below.\n" }, "timeoutInMinutes": { "type": "integer", "description": "The action timeout for the rule.\n" } }, "type": "object", "required": [ "name", "ruleTypeId" ] }, "aws:codepipeline/PipelineStageBeforeEntryConditionRuleRuleTypeId:PipelineStageBeforeEntryConditionRuleRuleTypeId": { "properties": { "category": { "type": "string", "description": "A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is `Rule`.\n" }, "owner": { "type": "string", "description": "The creator of the rule being called. The valid value for the Owner field in the rule category is `AWS`.\n" }, "provider": { "type": "string", "description": "The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "version": { "type": "string", "description": "A string that describes the rule version.\n" } }, "type": "object", "required": [ "category", "provider" ] }, "aws:codepipeline/PipelineStageOnFailure:PipelineStageOnFailure": { "properties": { "condition": { "$ref": "#/types/aws:codepipeline/PipelineStageOnFailureCondition:PipelineStageOnFailureCondition", "description": "The conditions that are failure conditions. Defined as a `condition` block below.\n" }, "result": { "type": "string", "description": "The conditions that are configured as failure conditions. Possible values are `ROLLBACK`, `FAIL`, `RETRY` and `SKIP`.\n" }, "retryConfiguration": { "$ref": "#/types/aws:codepipeline/PipelineStageOnFailureRetryConfiguration:PipelineStageOnFailureRetryConfiguration", "description": "The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode. Defined as a `retry_configuration` block below.\n" } }, "type": "object" }, "aws:codepipeline/PipelineStageOnFailureCondition:PipelineStageOnFailureCondition": { "properties": { "result": { "type": "string", "description": "The action to be done when the condition is met. For example, rolling back an execution for a failure condition. Possible values are `ROLLBACK`, `FAIL`, `RETRY` and `SKIP`.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineStageOnFailureConditionRule:PipelineStageOnFailureConditionRule" }, "description": "The rules that make up the condition. Defined as a `rule` block below.\n" } }, "type": "object", "required": [ "rules" ] }, "aws:codepipeline/PipelineStageOnFailureConditionRule:PipelineStageOnFailureConditionRule": { "properties": { "commands": { "type": "array", "items": { "type": "string" }, "description": "The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats.\n" }, "configuration": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The action configuration fields for the rule. Configurations options for rule types and providers can be found in the [Rule structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "inputArtifacts": { "type": "array", "items": { "type": "string" }, "description": "The list of the input artifacts fields for the rule, such as specifying an input file for the rule.\n" }, "name": { "type": "string", "description": "The name of the rule that is created for the condition, such as `VariableCheck`.\n" }, "region": { "type": "string", "description": "The Region for the condition associated with the rule.\n" }, "roleArn": { "type": "string", "description": "The pipeline role ARN associated with the rule.\n" }, "ruleTypeId": { "$ref": "#/types/aws:codepipeline/PipelineStageOnFailureConditionRuleRuleTypeId:PipelineStageOnFailureConditionRuleRuleTypeId", "description": "The ID for the rule type, which is made up of the combined values for `category`, `owner`, `provider`, and `version`. Defined as an `rule_type_id` block below.\n" }, "timeoutInMinutes": { "type": "integer", "description": "The action timeout for the rule.\n" } }, "type": "object", "required": [ "name", "ruleTypeId" ] }, "aws:codepipeline/PipelineStageOnFailureConditionRuleRuleTypeId:PipelineStageOnFailureConditionRuleRuleTypeId": { "properties": { "category": { "type": "string", "description": "A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is `Rule`.\n" }, "owner": { "type": "string", "description": "The creator of the rule being called. The valid value for the Owner field in the rule category is `AWS`.\n" }, "provider": { "type": "string", "description": "The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "version": { "type": "string", "description": "A string that describes the rule version.\n" } }, "type": "object", "required": [ "category", "provider" ] }, "aws:codepipeline/PipelineStageOnFailureRetryConfiguration:PipelineStageOnFailureRetryConfiguration": { "properties": { "retryMode": { "type": "string", "description": "The method that you want to configure for automatic stage retry on stage failure. You can specify to retry only failed action in the stage or all actions in the stage. Possible values are `FAILED_ACTIONS` and `ALL_ACTIONS`.\n" } }, "type": "object" }, "aws:codepipeline/PipelineStageOnSuccess:PipelineStageOnSuccess": { "properties": { "condition": { "$ref": "#/types/aws:codepipeline/PipelineStageOnSuccessCondition:PipelineStageOnSuccessCondition", "description": "The conditions that are success conditions. Defined as a `condition` block below.\n" } }, "type": "object", "required": [ "condition" ] }, "aws:codepipeline/PipelineStageOnSuccessCondition:PipelineStageOnSuccessCondition": { "properties": { "result": { "type": "string", "description": "The action to be done when the condition is met. For example, rolling back an execution for a failure condition. Possible values are `ROLLBACK`, `FAIL`, `RETRY` and `SKIP`.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineStageOnSuccessConditionRule:PipelineStageOnSuccessConditionRule" }, "description": "The rules that make up the condition. Defined as a `rule` block below.\n" } }, "type": "object", "required": [ "rules" ] }, "aws:codepipeline/PipelineStageOnSuccessConditionRule:PipelineStageOnSuccessConditionRule": { "properties": { "commands": { "type": "array", "items": { "type": "string" }, "description": "The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats.\n" }, "configuration": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The action configuration fields for the rule. Configurations options for rule types and providers can be found in the [Rule structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "inputArtifacts": { "type": "array", "items": { "type": "string" }, "description": "The list of the input artifacts fields for the rule, such as specifying an input file for the rule.\n" }, "name": { "type": "string", "description": "The name of the rule that is created for the condition, such as `VariableCheck`.\n" }, "region": { "type": "string", "description": "The Region for the condition associated with the rule.\n" }, "roleArn": { "type": "string", "description": "The pipeline role ARN associated with the rule.\n" }, "ruleTypeId": { "$ref": "#/types/aws:codepipeline/PipelineStageOnSuccessConditionRuleRuleTypeId:PipelineStageOnSuccessConditionRuleRuleTypeId", "description": "The ID for the rule type, which is made up of the combined values for `category`, `owner`, `provider`, and `version`. Defined as an `rule_type_id` block below.\n" }, "timeoutInMinutes": { "type": "integer", "description": "The action timeout for the rule.\n" } }, "type": "object", "required": [ "name", "ruleTypeId" ] }, "aws:codepipeline/PipelineStageOnSuccessConditionRuleRuleTypeId:PipelineStageOnSuccessConditionRuleRuleTypeId": { "properties": { "category": { "type": "string", "description": "A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is `Rule`.\n" }, "owner": { "type": "string", "description": "The creator of the rule being called. The valid value for the Owner field in the rule category is `AWS`.\n" }, "provider": { "type": "string", "description": "The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n" }, "version": { "type": "string", "description": "A string that describes the rule version.\n" } }, "type": "object", "required": [ "category", "provider" ] }, "aws:codepipeline/PipelineTrigger:PipelineTrigger": { "properties": { "gitConfiguration": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfiguration:PipelineTriggerGitConfiguration", "description": "Provides the filter criteria and the source stage for the repository event that starts the pipeline. For more information, refer to the [AWS documentation](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-filter.html). A `git_configuration` block is documented below.\n" }, "providerType": { "type": "string", "description": "The source provider for the event. Possible value is `CodeStarSourceConnection`.\n" } }, "type": "object", "required": [ "gitConfiguration", "providerType" ] }, "aws:codepipeline/PipelineTriggerAll:PipelineTriggerAll": { "properties": { "gitConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfiguration:PipelineTriggerAllGitConfiguration" }, "description": "Provides the filter criteria and the source stage for the repository event that starts the pipeline. For more information, refer to the [AWS documentation](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-filter.html). A `git_configuration` block is documented below.\n" }, "providerType": { "type": "string", "description": "The source provider for the event. Possible value is `CodeStarSourceConnection`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gitConfigurations", "providerType" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfiguration:PipelineTriggerAllGitConfiguration": { "properties": { "pullRequests": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequest:PipelineTriggerAllGitConfigurationPullRequest" }, "description": "The field where the repository event that will start the pipeline is specified as pull requests. A `pull_request` block is documented below.\n" }, "pushes": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPush:PipelineTriggerAllGitConfigurationPush" }, "description": "The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details. A `push` block is documented below.\n" }, "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.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "pullRequests", "pushes", "sourceActionName" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequest:PipelineTriggerAllGitConfigurationPullRequest": { "properties": { "branches": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequestBranch:PipelineTriggerAllGitConfigurationPullRequestBranch" }, "description": "The field that specifies to filter on branches for the pull request trigger configuration. A `branches` block is documented below.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "A list that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration. Possible values are `OPEN`, `UPDATED ` and `CLOSED`.\n" }, "filePaths": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequestFilePath:PipelineTriggerAllGitConfigurationPullRequestFilePath" }, "description": "The field that specifies to filter on file paths for the pull request trigger configuration. A `file_paths` block is documented below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branches", "events", "filePaths" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequestBranch:PipelineTriggerAllGitConfigurationPullRequestBranch": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludes", "includes" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPullRequestFilePath:PipelineTriggerAllGitConfigurationPullRequestFilePath": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludes", "includes" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPush:PipelineTriggerAllGitConfigurationPush": { "properties": { "branches": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPushBranch:PipelineTriggerAllGitConfigurationPushBranch" }, "description": "The field that specifies to filter on branches for the push trigger configuration. A `branches` block is documented below.\n" }, "filePaths": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPushFilePath:PipelineTriggerAllGitConfigurationPushFilePath" }, "description": "The field that specifies to filter on file paths for the push trigger configuration. A `file_paths` block is documented below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerAllGitConfigurationPushTag:PipelineTriggerAllGitConfigurationPushTag" }, "description": "The field that contains the details for the Git tags trigger configuration. A `tags` block is documented below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branches", "filePaths", "tags" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPushBranch:PipelineTriggerAllGitConfigurationPushBranch": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludes", "includes" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPushFilePath:PipelineTriggerAllGitConfigurationPushFilePath": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludes", "includes" ] } } }, "aws:codepipeline/PipelineTriggerAllGitConfigurationPushTag:PipelineTriggerAllGitConfigurationPushTag": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludes", "includes" ] } } }, "aws:codepipeline/PipelineTriggerGitConfiguration:PipelineTriggerGitConfiguration": { "properties": { "pullRequests": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPullRequest:PipelineTriggerGitConfigurationPullRequest" }, "description": "The field where the repository event that will start the pipeline is specified as pull requests. A `pull_request` block is documented below.\n" }, "pushes": { "type": "array", "items": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPush:PipelineTriggerGitConfigurationPush" }, "description": "The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details. A `push` block is documented below.\n" }, "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.\n" } }, "type": "object", "required": [ "sourceActionName" ] }, "aws:codepipeline/PipelineTriggerGitConfigurationPullRequest:PipelineTriggerGitConfigurationPullRequest": { "properties": { "branches": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPullRequestBranches:PipelineTriggerGitConfigurationPullRequestBranches", "description": "The field that specifies to filter on branches for the pull request trigger configuration. A `branches` block is documented below.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "A list that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration. Possible values are `OPEN`, `UPDATED ` and `CLOSED`.\n" }, "filePaths": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPullRequestFilePaths:PipelineTriggerGitConfigurationPullRequestFilePaths", "description": "The field that specifies to filter on file paths for the pull request trigger configuration. A `file_paths` block is documented below.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPullRequestBranches:PipelineTriggerGitConfigurationPullRequestBranches": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPullRequestFilePaths:PipelineTriggerGitConfigurationPullRequestFilePaths": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPush:PipelineTriggerGitConfigurationPush": { "properties": { "branches": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPushBranches:PipelineTriggerGitConfigurationPushBranches", "description": "The field that specifies to filter on branches for the push trigger configuration. A `branches` block is documented below.\n" }, "filePaths": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPushFilePaths:PipelineTriggerGitConfigurationPushFilePaths", "description": "The field that specifies to filter on file paths for the push trigger configuration. A `file_paths` block is documented below.\n" }, "tags": { "$ref": "#/types/aws:codepipeline/PipelineTriggerGitConfigurationPushTags:PipelineTriggerGitConfigurationPushTags", "description": "The field that contains the details for the Git tags trigger configuration. A `tags` block is documented below.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPushBranches:PipelineTriggerGitConfigurationPushBranches": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPushFilePaths:PipelineTriggerGitConfigurationPushFilePaths": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object" }, "aws:codepipeline/PipelineTriggerGitConfigurationPushTags:PipelineTriggerGitConfigurationPushTags": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "A list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.\n" } }, "type": "object" }, "aws:codepipeline/PipelineVariable:PipelineVariable": { "properties": { "defaultValue": { "type": "string", "description": "The default value of a pipeline-level variable.\n" }, "description": { "type": "string", "description": "The description of a pipeline-level variable.\n" }, "name": { "type": "string", "description": "The name of a pipeline-level variable.\n" } }, "type": "object", "required": [ "name" ] }, "aws:codepipeline/WebhookAuthenticationConfiguration:WebhookAuthenticationConfiguration": { "properties": { "allowedIpRange": { "type": "string", "description": "A valid CIDR block for `IP` filtering. Required for `IP`.\n", "willReplaceOnChanges": true }, "secretToken": { "type": "string", "description": "The shared secret for the GitHub repository webhook. Set this as `secret` in your `github_repository_webhook`'s `configuration` block. Required for `GITHUB_HMAC`.\n", "secret": true, "willReplaceOnChanges": true } }, "type": "object" }, "aws:codepipeline/WebhookFilter:WebhookFilter": { "properties": { "jsonPath": { "type": "string", "description": "The [JSON path](https://github.com/json-path/JsonPath) to filter on.\n" }, "matchEquals": { "type": "string", "description": "The value to match on (e.g., `refs/heads/{Branch}`). See [AWS docs](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_WebhookFilterRule.html) for details.\n" } }, "type": "object", "required": [ "jsonPath", "matchEquals" ] }, "aws:codestarconnections/HostVpcConfiguration:HostVpcConfiguration": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.\n" }, "tlsCertificate": { "type": "string", "description": "The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.\n" }, "vpcId": { "type": "string", "description": "The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds", "vpcId" ] }, "aws:codestarnotifications/NotificationRuleTarget:NotificationRuleTarget": { "properties": { "address": { "type": "string", "description": "The ARN of notification rule target. For example, a SNS Topic ARN.\n" }, "status": { "type": "string", "description": "The status of the notification rule. Possible values are `ENABLED` and `DISABLED`, default is `ENABLED`.\n" }, "type": { "type": "string", "description": "The type of the notification target. Default value is `SNS`.\n" } }, "type": "object", "required": [ "address" ], "language": { "nodejs": { "requiredOutputs": [ "address", "status" ] } } }, "aws:cognito/IdentityPoolCognitoIdentityProvider:IdentityPoolCognitoIdentityProvider": { "properties": { "clientId": { "type": "string", "description": "The client ID for the Amazon Cognito Identity User Pool.\n" }, "providerName": { "type": "string", "description": "The provider name for an Amazon Cognito Identity User Pool.\n" }, "serverSideTokenCheck": { "type": "boolean", "description": "Whether server-side token validation is enabled for the identity provider’s token or not.\n" } }, "type": "object" }, "aws:cognito/IdentityPoolRoleAttachmentRoleMapping:IdentityPoolRoleAttachmentRoleMapping": { "properties": { "ambiguousRoleResolution": { "type": "string", "description": "Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. `Required` if you specify Token or Rules as the Type.\n" }, "identityProvider": { "type": "string", "description": "A string identifying the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\". Depends on `cognito_identity_providers` set on `aws.cognito.IdentityPool` resource or a `aws.cognito.IdentityProvider` resource.\n" }, "mappingRules": { "type": "array", "items": { "$ref": "#/types/aws:cognito/IdentityPoolRoleAttachmentRoleMappingMappingRule:IdentityPoolRoleAttachmentRoleMappingMappingRule" }, "description": "The Rules Configuration to be used for mapping users to roles. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.\n" }, "type": { "type": "string", "description": "The role mapping type.\n" } }, "type": "object", "required": [ "identityProvider", "type" ] }, "aws:cognito/IdentityPoolRoleAttachmentRoleMappingMappingRule:IdentityPoolRoleAttachmentRoleMappingMappingRule": { "properties": { "claim": { "type": "string", "description": "The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\".\n" }, "matchType": { "type": "string", "description": "The match condition that specifies how closely the claim value in the IdP token must match Value.\n" }, "roleArn": { "type": "string", "description": "The role ARN.\n" }, "value": { "type": "string", "description": "A brief string that the claim must match, for example, \"paid\" or \"yes\".\n" } }, "type": "object", "required": [ "claim", "matchType", "roleArn", "value" ] }, "aws:cognito/ManagedUserPoolClientAnalyticsConfiguration:ManagedUserPoolClientAnalyticsConfiguration": { "properties": { "applicationArn": { "type": "string", "description": "Application ARN for an Amazon Pinpoint application. It conflicts with `external_id` and `role_arn`.\n" }, "applicationId": { "type": "string", "description": "Unique identifier for an Amazon Pinpoint application.\n" }, "externalId": { "type": "string", "description": "ID for the Analytics Configuration and conflicts with `application_arn`.\n" }, "roleArn": { "type": "string", "description": "ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. It conflicts with `application_arn`.\n" }, "userDataShared": { "type": "boolean", "description": "If `user_data_shared` is set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "roleArn", "userDataShared" ] } } }, "aws:cognito/ManagedUserPoolClientTokenValidityUnits:ManagedUserPoolClientTokenValidityUnits": { "properties": { "accessToken": { "type": "string", "description": "Time unit for the value in `access_token_validity` and defaults to `hours`.\n" }, "idToken": { "type": "string", "description": "Time unit for the value in `id_token_validity`, and it defaults to `hours`.\n" }, "refreshToken": { "type": "string", "description": "Time unit for the value in `refresh_token_validity` and defaults to `days`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessToken", "idToken", "refreshToken" ] } } }, "aws:cognito/ResourceServerScope:ResourceServerScope": { "properties": { "scopeDescription": { "type": "string", "description": "The scope description.\n" }, "scopeName": { "type": "string", "description": "The scope name.\n" } }, "type": "object", "required": [ "scopeDescription", "scopeName" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfiguration:RiskConfigurationAccountTakeoverRiskConfiguration": { "properties": { "actions": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActions:RiskConfigurationAccountTakeoverRiskConfigurationActions", "description": "Account takeover risk configuration actions. See details below.\n" }, "notifyConfiguration": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration", "description": "The notify configuration used to construct email notifications. See details below.\n" } }, "type": "object", "required": [ "actions", "notifyConfiguration" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActions:RiskConfigurationAccountTakeoverRiskConfigurationActions": { "properties": { "highAction": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction", "description": "Action to take for a high risk. See action block below.\n" }, "lowAction": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction", "description": "Action to take for a low risk. See action block below.\n" }, "mediumAction": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction", "description": "Action to take for a medium risk. See action block below.\n" } }, "type": "object" }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction": { "properties": { "eventAction": { "type": "string" }, "notify": { "type": "boolean", "description": "Whether to send a notification.\n" } }, "type": "object", "required": [ "eventAction", "notify" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction": { "properties": { "eventAction": { "type": "string" }, "notify": { "type": "boolean", "description": "Whether to send a notification.\n" } }, "type": "object", "required": [ "eventAction", "notify" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction:RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction": { "properties": { "eventAction": { "type": "string" }, "notify": { "type": "boolean", "description": "Whether to send a notification.\n" } }, "type": "object", "required": [ "eventAction", "notify" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration": { "properties": { "blockEmail": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail", "description": "Email template used when a detected risk event is blocked. See notify email type below.\n" }, "from": { "type": "string", "description": "The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.\n" }, "mfaEmail": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail", "description": "The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.\n" }, "noActionEmail": { "$ref": "#/types/aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail", "description": "The email template used when a detected risk event is allowed. See notify email type below.\n" }, "replyTo": { "type": "string", "description": "The destination to which the receiver of an email should reply to.\n" }, "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.\n" } }, "type": "object", "required": [ "sourceArn" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail": { "properties": { "htmlBody": { "type": "string", "description": "The email HTML body.\n" }, "subject": { "type": "string", "description": "The email subject.\n" }, "textBody": { "type": "string", "description": "The email text body.\n" } }, "type": "object", "required": [ "htmlBody", "subject", "textBody" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail": { "properties": { "htmlBody": { "type": "string", "description": "The email HTML body.\n" }, "subject": { "type": "string", "description": "The email subject.\n" }, "textBody": { "type": "string", "description": "The email text body.\n" } }, "type": "object", "required": [ "htmlBody", "subject", "textBody" ] }, "aws:cognito/RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail:RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail": { "properties": { "htmlBody": { "type": "string", "description": "The email HTML body.\n" }, "subject": { "type": "string", "description": "The email subject.\n" }, "textBody": { "type": "string", "description": "The email text body.\n" } }, "type": "object", "required": [ "htmlBody", "subject", "textBody" ] }, "aws:cognito/RiskConfigurationCompromisedCredentialsRiskConfiguration:RiskConfigurationCompromisedCredentialsRiskConfiguration": { "properties": { "actions": { "$ref": "#/types/aws:cognito/RiskConfigurationCompromisedCredentialsRiskConfigurationActions:RiskConfigurationCompromisedCredentialsRiskConfigurationActions", "description": "The compromised credentials risk configuration actions. See details below.\n" }, "eventFilters": { "type": "array", "items": { "type": "string" }, "description": "Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are `SIGN_IN`, `PASSWORD_CHANGE`, and `SIGN_UP`.\n" } }, "type": "object", "required": [ "actions" ], "language": { "nodejs": { "requiredOutputs": [ "actions", "eventFilters" ] } } }, "aws:cognito/RiskConfigurationCompromisedCredentialsRiskConfigurationActions:RiskConfigurationCompromisedCredentialsRiskConfigurationActions": { "properties": { "eventAction": { "type": "string", "description": "The event action. Valid values are `BLOCK` or `NO_ACTION`.\n" } }, "type": "object", "required": [ "eventAction" ] }, "aws:cognito/RiskConfigurationRiskExceptionConfiguration:RiskConfigurationRiskExceptionConfiguration": { "properties": { "blockedIpRangeLists": { "type": "array", "items": { "type": "string" }, "description": "Overrides the risk decision to always block the pre-authentication requests.\nThe IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.\nCan contain a maximum of 200 items.\n" }, "skippedIpRangeLists": { "type": "array", "items": { "type": "string" }, "description": "Risk detection isn't performed on the IP addresses in this range list.\nThe IP range is in CIDR notation.\nCan contain a maximum of 200 items.\n" } }, "type": "object" }, "aws:cognito/UserPoolAccountRecoverySetting:UserPoolAccountRecoverySetting": { "properties": { "recoveryMechanisms": { "type": "array", "items": { "$ref": "#/types/aws:cognito/UserPoolAccountRecoverySettingRecoveryMechanism:UserPoolAccountRecoverySettingRecoveryMechanism" }, "description": "List of Account Recovery Options of the following structure:\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "recoveryMechanisms" ] } } }, "aws:cognito/UserPoolAccountRecoverySettingRecoveryMechanism:UserPoolAccountRecoverySettingRecoveryMechanism": { "properties": { "name": { "type": "string", "description": "Recovery method for a user. Can be of the following: `verified_email`, `verified_phone_number`, and `admin_only`.\n" }, "priority": { "type": "integer", "description": "Positive integer specifying priority of a method with 1 being the highest priority.\n" } }, "type": "object", "required": [ "name", "priority" ] }, "aws:cognito/UserPoolAdminCreateUserConfig:UserPoolAdminCreateUserConfig": { "properties": { "allowAdminCreateUserOnly": { "type": "boolean", "description": "Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.\n" }, "inviteMessageTemplate": { "$ref": "#/types/aws:cognito/UserPoolAdminCreateUserConfigInviteMessageTemplate:UserPoolAdminCreateUserConfigInviteMessageTemplate", "description": "Invite message template structure. Detailed below.\n" } }, "type": "object" }, "aws:cognito/UserPoolAdminCreateUserConfigInviteMessageTemplate:UserPoolAdminCreateUserConfigInviteMessageTemplate": { "properties": { "emailMessage": { "type": "string", "description": "Message template for email messages. Must contain `{username}` and `{####}` placeholders, for username and temporary password, respectively.\n" }, "emailSubject": { "type": "string", "description": "Subject line for email messages.\n" }, "smsMessage": { "type": "string", "description": "Message template for SMS messages. Must contain `{username}` and `{####}` placeholders, for username and temporary password, respectively.\n" } }, "type": "object" }, "aws:cognito/UserPoolClientAnalyticsConfiguration:UserPoolClientAnalyticsConfiguration": { "properties": { "applicationArn": { "type": "string", "description": "Application ARN for an Amazon Pinpoint application. Conflicts with `external_id` and `role_arn`.\n" }, "applicationId": { "type": "string", "description": "Application ID for an Amazon Pinpoint application.\n" }, "externalId": { "type": "string", "description": "ID for the Analytics Configuration. Conflicts with `application_arn`.\n" }, "roleArn": { "type": "string", "description": "ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `application_arn`.\n" }, "userDataShared": { "type": "boolean", "description": "If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "roleArn", "userDataShared" ] } } }, "aws:cognito/UserPoolClientTokenValidityUnits:UserPoolClientTokenValidityUnits": { "properties": { "accessToken": { "type": "string", "description": "Time unit in for the value in `access_token_validity`, defaults to `hours`.\n" }, "idToken": { "type": "string", "description": "Time unit in for the value in `id_token_validity`, defaults to `hours`.\n" }, "refreshToken": { "type": "string", "description": "Time unit in for the value in `refresh_token_validity`, defaults to `days`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessToken", "idToken", "refreshToken" ] } } }, "aws:cognito/UserPoolDeviceConfiguration:UserPoolDeviceConfiguration": { "properties": { "challengeRequiredOnNewDevice": { "type": "boolean", "description": "Whether a challenge is required on a new device. Only applicable to a new device.\n" }, "deviceOnlyRememberedOnUserPrompt": { "type": "boolean", "description": "Whether a device is only remembered on user prompt. `false` equates to \"Always\" remember, `true` is \"User Opt In,\" and not using a `device_configuration` block is \"No.\"\n" } }, "type": "object" }, "aws:cognito/UserPoolEmailConfiguration:UserPoolEmailConfiguration": { "properties": { "configurationSet": { "type": "string", "description": "Email configuration set name from SES.\n" }, "emailSendingAccount": { "type": "string", "description": "Email delivery method to use. `COGNITO_DEFAULT` for the default email functionality built into Cognito or `DEVELOPER` to use your Amazon SES configuration. Required to be `DEVELOPER` if `from_email_address` is set.\n" }, "fromEmailAddress": { "type": "string", "description": "Sender’s email address or sender’s display name with their email address (e.g., `john@example.com`, `John Smith \u003cjohn@example.com\u003e` or `\\\"John Smith Ph.D.\\\" \u003cjohn@example.com\u003e`). Escaped double quotes are required around display names that contain certain characters as specified in [RFC 5322](https://tools.ietf.org/html/rfc5322).\n" }, "replyToEmailAddress": { "type": "string", "description": "REPLY-TO email address.\n" }, "sourceArn": { "type": "string", "description": "ARN of the SES verified email identity to use. Required if `email_sending_account` is set to `DEVELOPER`.\n" } }, "type": "object" }, "aws:cognito/UserPoolEmailMfaConfiguration:UserPoolEmailMfaConfiguration": { "properties": { "message": { "type": "string", "description": "The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.\n" }, "subject": { "type": "string", "description": "The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.\n" } }, "type": "object" }, "aws:cognito/UserPoolLambdaConfig:UserPoolLambdaConfig": { "properties": { "createAuthChallenge": { "type": "string", "description": "ARN of the lambda creating an authentication challenge.\n" }, "customEmailSender": { "$ref": "#/types/aws:cognito/UserPoolLambdaConfigCustomEmailSender:UserPoolLambdaConfigCustomEmailSender", "description": "A custom email sender AWS Lambda trigger. See custom_email_sender Below.\n" }, "customMessage": { "type": "string", "description": "Custom Message AWS Lambda trigger.\n" }, "customSmsSender": { "$ref": "#/types/aws:cognito/UserPoolLambdaConfigCustomSmsSender:UserPoolLambdaConfigCustomSmsSender", "description": "A custom SMS sender AWS Lambda trigger. See custom_sms_sender Below.\n" }, "defineAuthChallenge": { "type": "string", "description": "Defines the authentication challenge.\n" }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name of Key Management Service Customer master keys. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.\n" }, "postAuthentication": { "type": "string", "description": "Post-authentication AWS Lambda trigger.\n" }, "postConfirmation": { "type": "string", "description": "Post-confirmation AWS Lambda trigger.\n" }, "preAuthentication": { "type": "string", "description": "Pre-authentication AWS Lambda trigger.\n" }, "preSignUp": { "type": "string", "description": "Pre-registration AWS Lambda trigger.\n" }, "preTokenGeneration": { "type": "string", "description": "Allow to customize identity token claims before token generation. Set this parameter for legacy purposes; for new instances of pre token generation triggers, set the lambda_arn of `pre_token_generation_config`.\n" }, "preTokenGenerationConfig": { "$ref": "#/types/aws:cognito/UserPoolLambdaConfigPreTokenGenerationConfig:UserPoolLambdaConfigPreTokenGenerationConfig", "description": "Allow to customize access tokens. See pre_token_configuration_type\n" }, "userMigration": { "type": "string", "description": "User migration Lambda config type.\n" }, "verifyAuthChallengeResponse": { "type": "string", "description": "Verifies the authentication challenge response.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preTokenGeneration", "preTokenGenerationConfig" ] } } }, "aws:cognito/UserPoolLambdaConfigCustomEmailSender:UserPoolLambdaConfigCustomEmailSender": { "properties": { "lambdaArn": { "type": "string", "description": "The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send email notifications to users.\n" }, "lambdaVersion": { "type": "string", "description": "The Lambda version represents the signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your custom email Lambda function. The only supported value is `V1_0`.\n" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ] }, "aws:cognito/UserPoolLambdaConfigCustomSmsSender:UserPoolLambdaConfigCustomSmsSender": { "properties": { "lambdaArn": { "type": "string", "description": "The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send SMS notifications to users.\n" }, "lambdaVersion": { "type": "string", "description": "The Lambda version represents the signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your custom SMS Lambda function. The only supported value is `V1_0`.\n" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ] }, "aws:cognito/UserPoolLambdaConfigPreTokenGenerationConfig:UserPoolLambdaConfigPreTokenGenerationConfig": { "properties": { "lambdaArn": { "type": "string" }, "lambdaVersion": { "type": "string" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ] }, "aws:cognito/UserPoolPasswordPolicy:UserPoolPasswordPolicy": { "properties": { "minimumLength": { "type": "integer", "description": "Minimum length of the password policy that you have set.\n" }, "passwordHistorySize": { "type": "integer", "description": "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 number of previous passwords specified by this argument. A value of 0 means that password history is not enforced. Valid values are between 0 and 24.\n\n**Note:** This argument requires advanced security features to be active in the user pool.\n" }, "requireLowercase": { "type": "boolean", "description": "Whether you have required users to use at least one lowercase letter in their password.\n" }, "requireNumbers": { "type": "boolean", "description": "Whether you have required users to use at least one number in their password.\n" }, "requireSymbols": { "type": "boolean", "description": "Whether you have required users to use at least one symbol in their password.\n" }, "requireUppercase": { "type": "boolean", "description": "Whether you have required users to use at least one uppercase letter in their password.\n" }, "temporaryPasswordValidityDays": { "type": "integer", "description": "In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "temporaryPasswordValidityDays" ] } } }, "aws:cognito/UserPoolSchema:UserPoolSchema": { "properties": { "attributeDataType": { "type": "string", "description": "Attribute data type. Must be one of `Boolean`, `Number`, `String`, `DateTime`.\n" }, "developerOnlyAttribute": { "type": "boolean", "description": "Whether the attribute type is developer only.\n" }, "mutable": { "type": "boolean", "description": "Whether the attribute can be changed once it has been created.\n" }, "name": { "type": "string", "description": "Name of the attribute.\n" }, "numberAttributeConstraints": { "$ref": "#/types/aws:cognito/UserPoolSchemaNumberAttributeConstraints:UserPoolSchemaNumberAttributeConstraints", "description": "Configuration block for the constraints for an attribute of the number type. Detailed below.\n" }, "required": { "type": "boolean", "description": "Whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.\n" }, "stringAttributeConstraints": { "$ref": "#/types/aws:cognito/UserPoolSchemaStringAttributeConstraints:UserPoolSchemaStringAttributeConstraints", "description": "Constraints for an attribute of the string type. Detailed below.\n" } }, "type": "object", "required": [ "attributeDataType", "name" ] }, "aws:cognito/UserPoolSchemaNumberAttributeConstraints:UserPoolSchemaNumberAttributeConstraints": { "properties": { "maxValue": { "type": "string", "description": "Maximum value of an attribute that is of the number data type.\n" }, "minValue": { "type": "string", "description": "Minimum value of an attribute that is of the number data type.\n" } }, "type": "object" }, "aws:cognito/UserPoolSchemaStringAttributeConstraints:UserPoolSchemaStringAttributeConstraints": { "properties": { "maxLength": { "type": "string", "description": "Maximum length of an attribute value of the string type.\n" }, "minLength": { "type": "string", "description": "Minimum length of an attribute value of the string type.\n" } }, "type": "object" }, "aws:cognito/UserPoolSignInPolicy:UserPoolSignInPolicy": { "properties": { "allowedFirstAuthFactors": { "type": "array", "items": { "type": "string" }, "description": "The sign in methods your user pool supports as the first factor. This is a list of strings, allowed values are `PASSWORD`, `EMAIL_OTP`, `SMS_OTP`, and `WEB_AUTHN`.\n" } }, "type": "object" }, "aws:cognito/UserPoolSmsConfiguration:UserPoolSmsConfiguration": { "properties": { "externalId": { "type": "string", "description": "External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).\n" }, "snsCallerArn": { "type": "string", "description": "ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.\n" }, "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. Amazon 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).\n" } }, "type": "object", "required": [ "externalId", "snsCallerArn" ], "language": { "nodejs": { "requiredOutputs": [ "externalId", "snsCallerArn", "snsRegion" ] } } }, "aws:cognito/UserPoolSoftwareTokenMfaConfiguration:UserPoolSoftwareTokenMfaConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA When `sms_configuration` is not present, the `mfa_configuration` argument must be set to `OFF` and the `software_token_mfa_configuration` configuration block must be fully removed.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:cognito/UserPoolUserAttributeUpdateSettings:UserPoolUserAttributeUpdateSettings": { "properties": { "attributesRequireVerificationBeforeUpdates": { "type": "array", "items": { "type": "string" }, "description": "A list of attributes requiring verification before update. If set, the provided value(s) must also be set in `auto_verified_attributes`. Valid values: `email`, `phone_number`.\n" } }, "type": "object", "required": [ "attributesRequireVerificationBeforeUpdates" ] }, "aws:cognito/UserPoolUserPoolAddOns:UserPoolUserPoolAddOns": { "properties": { "advancedSecurityMode": { "type": "string", "description": "Mode for advanced security, must be one of `OFF`, `AUDIT` or `ENFORCED`.\n" } }, "type": "object", "required": [ "advancedSecurityMode" ] }, "aws:cognito/UserPoolUsernameConfiguration:UserPoolUsernameConfiguration": { "properties": { "caseSensitive": { "type": "boolean", "description": "Whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "caseSensitive" ] } } }, "aws:cognito/UserPoolVerificationMessageTemplate:UserPoolVerificationMessageTemplate": { "properties": { "defaultEmailOption": { "type": "string", "description": "Default email option. Must be either `CONFIRM_WITH_CODE` or `CONFIRM_WITH_LINK`. Defaults to `CONFIRM_WITH_CODE`.\n" }, "emailMessage": { "type": "string", "description": "Email message template. Must contain the `{####}` placeholder. Conflicts with `email_verification_message` argument.\n" }, "emailMessageByLink": { "type": "string", "description": "Email message template for sending a confirmation link to the user, it must contain the `{##Click Here##}` placeholder.\n" }, "emailSubject": { "type": "string", "description": "Subject line for the email message template. Conflicts with `email_verification_subject` argument.\n" }, "emailSubjectByLink": { "type": "string", "description": "Subject line for the email message template for sending a confirmation link to the user.\n" }, "smsMessage": { "type": "string", "description": "SMS message template. Must contain the `{####}` placeholder. Conflicts with `sms_verification_message` argument.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "emailMessage", "emailMessageByLink", "emailSubject", "emailSubjectByLink", "smsMessage" ] } } }, "aws:cognito/UserPoolWebAuthnConfiguration:UserPoolWebAuthnConfiguration": { "properties": { "relyingPartyId": { "type": "string", "description": "The authentication domain that passkeys providers use as a relying party.\n" }, "userVerification": { "type": "string", "description": "If your user pool should require a passkey. Must be one of `required` or `preferred`.\n" } }, "type": "object" }, "aws:cognito/getIdentityPoolCognitoIdentityProvider:getIdentityPoolCognitoIdentityProvider": { "properties": { "clientId": { "type": "string" }, "providerName": { "type": "string" }, "serverSideTokenCheck": { "type": "boolean" } }, "type": "object", "required": [ "clientId", "providerName", "serverSideTokenCheck" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserGroupsGroup:getUserGroupsGroup": { "properties": { "description": { "type": "string", "description": "Description of the user group.\n" }, "groupName": { "type": "string", "description": "Name of the user group.\n" }, "precedence": { "type": "integer", "description": "Precedence of the user group.\n" }, "roleArn": { "type": "string", "description": "ARN of the IAM role to be associated with the user group.\n" } }, "type": "object", "required": [ "description", "groupName", "precedence", "roleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolAccountRecoverySetting:getUserPoolAccountRecoverySetting": { "properties": { "recoveryMechanisms": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolAccountRecoverySettingRecoveryMechanism:getUserPoolAccountRecoverySettingRecoveryMechanism" } } }, "type": "object", "required": [ "recoveryMechanisms" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolAccountRecoverySettingRecoveryMechanism:getUserPoolAccountRecoverySettingRecoveryMechanism": { "properties": { "name": { "type": "string", "description": "- Name of the attribute.\n" }, "priority": { "type": "integer", "description": "- Priority of this mechanism in the recovery process (lower numbers are higher priority).\n" } }, "type": "object", "required": [ "name", "priority" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolAdminCreateUserConfig:getUserPoolAdminCreateUserConfig": { "properties": { "allowAdminCreateUserOnly": { "type": "boolean", "description": "- Whether only admins can create users.\n" }, "inviteMessageTemplates": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolAdminCreateUserConfigInviteMessageTemplate:getUserPoolAdminCreateUserConfigInviteMessageTemplate" } }, "unusedAccountValidityDays": { "type": "integer", "description": "- Number of days an unconfirmed user account remains valid.\n* invite_message_template - Templates for invitation messages.\n" } }, "type": "object", "required": [ "allowAdminCreateUserOnly", "inviteMessageTemplates", "unusedAccountValidityDays" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolAdminCreateUserConfigInviteMessageTemplate:getUserPoolAdminCreateUserConfigInviteMessageTemplate": { "properties": { "emailMessage": { "type": "string", "description": "- Email message content.\n" }, "emailSubject": { "type": "string", "description": "- Email message subject.\n" }, "smsMessage": { "type": "string", "description": "- SMS message content.\n" } }, "type": "object", "required": [ "emailMessage", "emailSubject", "smsMessage" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolClientAnalyticsConfiguration:getUserPoolClientAnalyticsConfiguration": { "properties": { "applicationArn": { "type": "string", "description": "(Optional) Application ARN for an Amazon Pinpoint application. Conflicts with `external_id` and `role_arn`.\n" }, "applicationId": { "type": "string", "description": "(Optional) Application ID for an Amazon Pinpoint application.\n" }, "externalId": { "type": "string", "description": "(Optional) ID for the Analytics Configuration. Conflicts with `application_arn`.\n" }, "roleArn": { "type": "string", "description": "(Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `application_arn`.\n" }, "userDataShared": { "type": "boolean", "description": "(Optional) If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.\n" } }, "type": "object", "required": [ "applicationArn", "applicationId", "externalId", "roleArn", "userDataShared" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolClientTokenValidityUnit:getUserPoolClientTokenValidityUnit": { "properties": { "accessToken": { "type": "string", "description": "(Optional) Time unit in for the value in `access_token_validity`, defaults to `hours`.\n" }, "idToken": { "type": "string", "description": "(Optional) Time unit in for the value in `id_token_validity`, defaults to `hours`.\n" }, "refreshToken": { "type": "string", "description": "(Optional) Time unit in for the value in `refresh_token_validity`, defaults to `days`.\n" } }, "type": "object", "required": [ "accessToken", "idToken", "refreshToken" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolDeviceConfiguration:getUserPoolDeviceConfiguration": { "properties": { "challengeRequiredOnNewDevice": { "type": "boolean", "description": "- Whether a challenge is required on new devices.\n" }, "deviceOnlyRememberedOnUserPrompt": { "type": "boolean", "description": "- Whether devices are only remembered if the user prompts it.\n" } }, "type": "object", "required": [ "challengeRequiredOnNewDevice", "deviceOnlyRememberedOnUserPrompt" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolEmailConfiguration:getUserPoolEmailConfiguration": { "properties": { "configurationSet": { "type": "string", "description": "- Configuration set used for sending emails.\n" }, "emailSendingAccount": { "type": "string", "description": "- Email sending account.\n" }, "from": { "type": "string", "description": "- Email sender address.\n" }, "replyToEmailAddress": { "type": "string", "description": "- Reply-to email address.\n" }, "sourceArn": { "type": "string", "description": "- Source Amazon Resource Name (ARN) for emails.\n" } }, "type": "object", "required": [ "configurationSet", "emailSendingAccount", "from", "replyToEmailAddress", "sourceArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolLambdaConfig:getUserPoolLambdaConfig": { "properties": { "createAuthChallenge": { "type": "string" }, "customEmailSenders": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolLambdaConfigCustomEmailSender:getUserPoolLambdaConfigCustomEmailSender" } }, "customMessage": { "type": "string" }, "customSmsSenders": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolLambdaConfigCustomSmsSender:getUserPoolLambdaConfigCustomSmsSender" } }, "defineAuthChallenge": { "type": "string" }, "kmsKeyId": { "type": "string" }, "postAuthentication": { "type": "string" }, "postConfirmation": { "type": "string" }, "preAuthentication": { "type": "string" }, "preSignUp": { "type": "string" }, "preTokenGeneration": { "type": "string" }, "preTokenGenerationConfigs": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolLambdaConfigPreTokenGenerationConfig:getUserPoolLambdaConfigPreTokenGenerationConfig" } }, "userMigration": { "type": "string" }, "verifyAuthChallengeResponse": { "type": "string" } }, "type": "object", "required": [ "createAuthChallenge", "customEmailSenders", "customMessage", "customSmsSenders", "defineAuthChallenge", "kmsKeyId", "postAuthentication", "postConfirmation", "preAuthentication", "preSignUp", "preTokenGeneration", "preTokenGenerationConfigs", "userMigration", "verifyAuthChallengeResponse" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolLambdaConfigCustomEmailSender:getUserPoolLambdaConfigCustomEmailSender": { "properties": { "lambdaArn": { "type": "string", "description": "- ARN of the Lambda function.\n" }, "lambdaVersion": { "type": "string", "description": "- Version of the Lambda function.\n" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolLambdaConfigCustomSmsSender:getUserPoolLambdaConfigCustomSmsSender": { "properties": { "lambdaArn": { "type": "string", "description": "- ARN of the Lambda function.\n" }, "lambdaVersion": { "type": "string", "description": "- Version of the Lambda function.\n" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolLambdaConfigPreTokenGenerationConfig:getUserPoolLambdaConfigPreTokenGenerationConfig": { "properties": { "lambdaArn": { "type": "string", "description": "- ARN of the Lambda function.\n" }, "lambdaVersion": { "type": "string", "description": "- Version of the Lambda function.\n" } }, "type": "object", "required": [ "lambdaArn", "lambdaVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolSchemaAttribute:getUserPoolSchemaAttribute": { "properties": { "attributeDataType": { "type": "string", "description": "- Data type of the attribute (e.g., string, number).\n" }, "developerOnlyAttribute": { "type": "boolean", "description": "- Whether the attribute is for developer use only.\n" }, "mutable": { "type": "boolean", "description": "- Whether the attribute can be changed after user creation.\n" }, "name": { "type": "string", "description": "- Name of the attribute.\n" }, "numberAttributeConstraints": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolSchemaAttributeNumberAttributeConstraint:getUserPoolSchemaAttributeNumberAttributeConstraint" } }, "required": { "type": "boolean", "description": "- Whether the attribute is required during user registration.\n* number_attribute_constraints - Constraints for numeric attributes.\n* string_attribute_constraints - Constraints for string attributes.\n" }, "stringAttributeConstraints": { "type": "array", "items": { "$ref": "#/types/aws:cognito/getUserPoolSchemaAttributeStringAttributeConstraint:getUserPoolSchemaAttributeStringAttributeConstraint" } } }, "type": "object", "required": [ "attributeDataType", "developerOnlyAttribute", "mutable", "name", "numberAttributeConstraints", "required", "stringAttributeConstraints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolSchemaAttributeNumberAttributeConstraint:getUserPoolSchemaAttributeNumberAttributeConstraint": { "properties": { "maxValue": { "type": "string", "description": "- Maximum allowed value.\n" }, "minValue": { "type": "string", "description": "- Minimum allowed value.\n" } }, "type": "object", "required": [ "maxValue", "minValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:cognito/getUserPoolSchemaAttributeStringAttributeConstraint:getUserPoolSchemaAttributeStringAttributeConstraint": { "properties": { "maxLength": { "type": "string", "description": "- Maximum allowed length.\n" }, "minLength": { "type": "string", "description": "- Minimum allowed length.\n" } }, "type": "object", "required": [ "maxLength", "minLength" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:comprehend/DocumentClassifierInputDataConfig:DocumentClassifierInputDataConfig": { "properties": { "augmentedManifests": { "type": "array", "items": { "$ref": "#/types/aws:comprehend/DocumentClassifierInputDataConfigAugmentedManifest:DocumentClassifierInputDataConfigAugmentedManifest" }, "description": "List of training datasets produced by Amazon SageMaker AI Ground Truth.\nUsed if `data_format` is `AUGMENTED_MANIFEST`.\nSee the `augmented_manifests` Configuration Block section below.\n" }, "dataFormat": { "type": "string", "description": "The format for the training data.\nOne of `COMPREHEND_CSV` or `AUGMENTED_MANIFEST`.\n" }, "labelDelimiter": { "type": "string", "description": "Delimiter between labels when training a multi-label classifier.\nValid values are `|`, `~`, `!`, `@`, `#`, `$`, `%`, `^`, `*`, `-`, `_`, `+`, `=`, `\\`, `:`, `;`, `\u003e`, `?`, `/`, `\u003cspace\u003e`, and `\u003ctab\u003e`.\nDefault is `|`.\n" }, "s3Uri": { "type": "string", "description": "Location of training documents.\nUsed if `data_format` is `COMPREHEND_CSV`.\n" }, "testS3Uri": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "labelDelimiter" ] } } }, "aws:comprehend/DocumentClassifierInputDataConfigAugmentedManifest:DocumentClassifierInputDataConfigAugmentedManifest": { "properties": { "annotationDataS3Uri": { "type": "string", "description": "Location of annotation files.\n" }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "The JSON attribute that contains the annotations for the training documents.\n" }, "documentType": { "type": "string", "description": "Type of augmented manifest.\nOne of `PLAIN_TEXT_DOCUMENT` or `SEMI_STRUCTURED_DOCUMENT`.\n" }, "s3Uri": { "type": "string", "description": "Location of augmented manifest file.\n" }, "sourceDocumentsS3Uri": { "type": "string", "description": "Location of source PDF files.\n" }, "split": { "type": "string", "description": "Purpose of data in augmented manifest.\nOne of `TRAIN` or `TEST`.\n" } }, "type": "object", "required": [ "attributeNames", "s3Uri" ] }, "aws:comprehend/DocumentClassifierOutputDataConfig:DocumentClassifierOutputDataConfig": { "properties": { "kmsKeyId": { "type": "string", "description": "KMS Key used to encrypt the output documents.\nCan be a KMS Key ID, a KMS Key ARN, a KMS Alias name, or a KMS Alias ARN.\n" }, "outputS3Uri": { "type": "string", "description": "Full path for the output documents.\n" }, "s3Uri": { "type": "string", "description": "Destination path for the output documents.\nThe full path to the output file will be returned in `output_s3_uri`.\n" } }, "type": "object", "required": [ "s3Uri" ], "language": { "nodejs": { "requiredOutputs": [ "outputS3Uri", "s3Uri" ] } } }, "aws:comprehend/DocumentClassifierVpcConfig:DocumentClassifierVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "List of VPC subnets.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnets" ] }, "aws:comprehend/EntityRecognizerInputDataConfig:EntityRecognizerInputDataConfig": { "properties": { "annotations": { "$ref": "#/types/aws:comprehend/EntityRecognizerInputDataConfigAnnotations:EntityRecognizerInputDataConfigAnnotations", "description": "Specifies location of the document annotation data.\nSee the `annotations` Configuration Block section below.\nOne of `annotations` or `entity_list` is required.\n" }, "augmentedManifests": { "type": "array", "items": { "$ref": "#/types/aws:comprehend/EntityRecognizerInputDataConfigAugmentedManifest:EntityRecognizerInputDataConfigAugmentedManifest" }, "description": "List of training datasets produced by Amazon SageMaker AI Ground Truth.\nUsed if `data_format` is `AUGMENTED_MANIFEST`.\nSee the `augmented_manifests` Configuration Block section below.\n" }, "dataFormat": { "type": "string", "description": "The format for the training data.\nOne of `COMPREHEND_CSV` or `AUGMENTED_MANIFEST`.\n" }, "documents": { "$ref": "#/types/aws:comprehend/EntityRecognizerInputDataConfigDocuments:EntityRecognizerInputDataConfigDocuments", "description": "Specifies a collection of training documents.\nUsed if `data_format` is `COMPREHEND_CSV`.\nSee the `documents` Configuration Block section below.\n" }, "entityList": { "$ref": "#/types/aws:comprehend/EntityRecognizerInputDataConfigEntityList:EntityRecognizerInputDataConfigEntityList", "description": "Specifies location of the entity list data.\nSee the `entity_list` Configuration Block section below.\nOne of `entity_list` or `annotations` is required.\n" }, "entityTypes": { "type": "array", "items": { "$ref": "#/types/aws:comprehend/EntityRecognizerInputDataConfigEntityType:EntityRecognizerInputDataConfigEntityType" }, "description": "Set of entity types to be recognized.\nHas a maximum of 25 items.\nSee the `entity_types` Configuration Block section below.\n" } }, "type": "object", "required": [ "entityTypes" ] }, "aws:comprehend/EntityRecognizerInputDataConfigAnnotations:EntityRecognizerInputDataConfigAnnotations": { "properties": { "s3Uri": { "type": "string", "description": "Location of training annotations.\n" }, "testS3Uri": { "type": "string" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:comprehend/EntityRecognizerInputDataConfigAugmentedManifest:EntityRecognizerInputDataConfigAugmentedManifest": { "properties": { "annotationDataS3Uri": { "type": "string", "description": "Location of annotation files.\n" }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "The JSON attribute that contains the annotations for the training documents.\n" }, "documentType": { "type": "string", "description": "Type of augmented manifest.\nOne of `PLAIN_TEXT_DOCUMENT` or `SEMI_STRUCTURED_DOCUMENT`.\n" }, "s3Uri": { "type": "string", "description": "Location of augmented manifest file.\n" }, "sourceDocumentsS3Uri": { "type": "string", "description": "Location of source PDF files.\n" }, "split": { "type": "string", "description": "Purpose of data in augmented manifest.\nOne of `TRAIN` or `TEST`.\n" } }, "type": "object", "required": [ "attributeNames", "s3Uri" ] }, "aws:comprehend/EntityRecognizerInputDataConfigDocuments:EntityRecognizerInputDataConfigDocuments": { "properties": { "inputFormat": { "type": "string", "description": "Specifies how the input files should be processed.\nOne of `ONE_DOC_PER_LINE` or `ONE_DOC_PER_FILE`.\n" }, "s3Uri": { "type": "string", "description": "Location of training documents.\n" }, "testS3Uri": { "type": "string" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:comprehend/EntityRecognizerInputDataConfigEntityList:EntityRecognizerInputDataConfigEntityList": { "properties": { "s3Uri": { "type": "string", "description": "Location of entity list.\n" } }, "type": "object", "required": [ "s3Uri" ] }, "aws:comprehend/EntityRecognizerInputDataConfigEntityType:EntityRecognizerInputDataConfigEntityType": { "properties": { "type": { "type": "string", "description": "An entity type to be matched by the Entity Recognizer.\nCannot contain a newline (`\\n`), carriage return (`\\r`), or tab (`\\t`).\n" } }, "type": "object", "required": [ "type" ] }, "aws:comprehend/EntityRecognizerVpcConfig:EntityRecognizerVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "List of VPC subnets.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnets" ] }, "aws:computeoptimizer/EnrollmentStatusTimeouts:EnrollmentStatusTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:computeoptimizer/RecommendationPreferencesExternalMetricsPreference:RecommendationPreferencesExternalMetricsPreference": { "properties": { "source": { "type": "string", "description": "The source options for external metrics preferences. Valid values: `Datadog`, `Dynatrace`, `NewRelic`, `Instana`.\n" } }, "type": "object", "required": [ "source" ] }, "aws:computeoptimizer/RecommendationPreferencesPreferredResource:RecommendationPreferencesPreferredResource": { "properties": { "excludeLists": { "type": "array", "items": { "type": "string" }, "description": "The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default.\n" }, "includeLists": { "type": "array", "items": { "type": "string" }, "description": "The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as `\"m5.large\"`, or use wild card expressions, such as `\"m5\"`. If this isn’t specified, all supported resources are included by default.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "name" ] }, "aws:computeoptimizer/RecommendationPreferencesScope:RecommendationPreferencesScope": { "properties": { "name": { "type": "string", "description": "The name of the scope. Valid values: `Organization`, `AccountId`, `ResourceArn`.\n" }, "value": { "type": "string", "description": "The value of the scope. `ALL_ACCOUNTS` for `Organization` scopes, AWS account ID for `AccountId` scopes, ARN of an EC2 instance or an Auto Scaling group for `ResourceArn` scopes.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:computeoptimizer/RecommendationPreferencesUtilizationPreference:RecommendationPreferencesUtilizationPreference": { "properties": { "metricName": { "type": "string", "description": "The name of the resource utilization metric name to customize. Valid values: `CpuUtilization`, `MemoryUtilization`.\n" }, "metricParameters": { "$ref": "#/types/aws:computeoptimizer/RecommendationPreferencesUtilizationPreferenceMetricParameters:RecommendationPreferencesUtilizationPreferenceMetricParameters", "description": "The parameters to set when customizing the resource utilization thresholds.\n" } }, "type": "object", "required": [ "metricName" ] }, "aws:computeoptimizer/RecommendationPreferencesUtilizationPreferenceMetricParameters:RecommendationPreferencesUtilizationPreferenceMetricParameters": { "properties": { "headroom": { "type": "string", "description": "The headroom value in percentage used for the specified metric parameter. Valid values: `PERCENT_30`, `PERCENT_20`, `PERCENT_10`, `PERCENT_0`.\n" }, "threshold": { "type": "string", "description": "The threshold value used for the specified metric parameter. You can only specify the threshold value for CPU utilization. Valid values: `P90`, `P95`, `P99_5`.\n" } }, "type": "object", "required": [ "headroom" ] }, "aws:config/assumeRole:assumeRole": { "properties": { "duration": { "type": "string", "description": "The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.\n" }, "externalId": { "type": "string", "description": "A unique identifier that might be required when you assume a role in another account.\n" }, "policy": { "type": "string", "description": "IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.\n" }, "policyArns": { "type": "array", "items": { "type": "string" }, "description": "Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.\n" }, "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.\n" }, "sessionName": { "type": "string", "description": "An identifier for the assumed role session.\n" }, "sourceIdentity": { "type": "string", "description": "Source identity specified by the principal assuming the role.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Assume role session tags.\n" }, "transitiveTagKeys": { "type": "array", "items": { "type": "string" }, "description": "Assume role session tag keys to pass to any subsequent sessions.\n" } }, "type": "object" }, "aws:config/assumeRoleWithWebIdentity:assumeRoleWithWebIdentity": { "properties": { "duration": { "type": "string", "description": "The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.\n" }, "policy": { "type": "string", "description": "IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.\n" }, "policyArns": { "type": "array", "items": { "type": "string" }, "description": "Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.\n" }, "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.\n" }, "sessionName": { "type": "string", "description": "An identifier for the assumed role session.\n" }, "webIdentityToken": { "type": "string" }, "webIdentityTokenFile": { "type": "string" } }, "type": "object" }, "aws:config/defaultTags:defaultTags": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags to default across all resources. Can also be configured with environment variables like `TF_AWS_DEFAULT_TAGS_\u003ctag_name\u003e`.\n" } }, "type": "object" }, "aws:config/endpoints:endpoints": { "properties": { "accessanalyzer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "account": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "acm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "acmpca": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amg": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amp": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amplify": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apigateway": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apigatewayv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appautoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appconfig": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appfabric": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appflow": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appintegrations": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appintegrationsservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationautoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationinsights": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationsignals": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appmesh": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appregistry": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apprunner": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appstream": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appsync": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "athena": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "auditmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "autoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "autoscalingplans": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "backup": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "batch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bcmdataexports": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "beanstalk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bedrock": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bedrockagent": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "billing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "budgets": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ce": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chatbot": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chime": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chimesdkmediapipelines": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chimesdkvoice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cleanrooms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloud9": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudcontrol": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudcontrolapi": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudformation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudfront": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudfrontkeyvaluestore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudhsm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudhsmv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudsearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudtrail": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchevents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchevidently": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchlog": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchlogs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchobservabilityaccessmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchrum": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeartifact": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codebuild": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codecatalyst": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codecommit": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeconnections": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codedeploy": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeguruprofiler": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codegurureviewer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codepipeline": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codestarconnections": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codestarnotifications": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidentity": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidentityprovider": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidp": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "comprehend": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "computeoptimizer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "config": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "configservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "connect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "connectcases": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "controltower": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costandusagereportservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costexplorer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costoptimizationhub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cur": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "customerprofiles": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databasemigration": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databasemigrationservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databrew": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dataexchange": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datapipeline": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datasync": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datazone": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dax": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "deploy": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "detective": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "devicefarm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "devopsguru": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "directconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "directoryservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dlm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "docdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "docdbelastic": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "drs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ds": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dsql": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dynamodb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ec2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecr": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecrpublic": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "efs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "eks": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticache": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticbeanstalk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticloadbalancing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticloadbalancingv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticsearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticsearchservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elastictranscoder": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elbv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emr": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emrcontainers": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emrserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "es": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "eventbridge": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "events": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "evidently": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "finspace": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "firehose": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fsx": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "gamelift": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "glacier": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "globalaccelerator": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "glue": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "gluedatabrew": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "grafana": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "greengrass": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "groundstation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "guardduty": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "healthlake": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iam": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "identitystore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "imagebuilder": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspector": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspector2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspectorv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "internetmonitor": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "invoicing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iot": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iotanalytics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iotevents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ivs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ivschat": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kafka": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kafkaconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kendra": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "keyspaces": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisanalytics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisanalyticsv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisvideo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lakeformation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lambda": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "launchwizard": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lex": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelbuilding": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelbuildingservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodels": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelsv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexv2models": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "licensemanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lightsail": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "location": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "locationservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "logs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lookoutmetrics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "m2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "macie2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "managedgrafana": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediaconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediaconvert": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "medialive": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackage": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackagev2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackagevod": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediastore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "memorydb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mgn": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mq": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "msk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mwaa": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "neptune": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "neptunegraph": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkfirewall": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkmonitor": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "oam": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchingestion": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opsworks": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "organizations": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "osis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "outposts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "paymentcryptography": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pcaconnectorad": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pcs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pinpoint": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pinpointsmsvoicev2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pipes": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "polly": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pricing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "prometheus": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "prometheusservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "qbusiness": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "qldb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "quicksight": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ram": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rbin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rds": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "recyclebin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshift": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftdata": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftdataapiservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rekognition": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resiliencehub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourceexplorer2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroups": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroupstagging": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroupstaggingapi": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rolesanywhere": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53domains": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53profiles": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53recoverycontrolconfig": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53recoveryreadiness": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53resolver": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rum": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3api": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3control": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3outposts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3tables": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sagemaker": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "scheduler": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "schemas": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "secretsmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "securityhub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "securitylake": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessapplicationrepository": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessapprepo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessrepo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicecatalog": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicecatalogappregistry": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicediscovery": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicequotas": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ses": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sesv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sfn": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "shield": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "signer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "simpledb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sns": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sqs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmcontacts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmincidents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmquicksetup": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmsap": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sso": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssoadmin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "stepfunctions": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "storagegateway": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "swf": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "synthetics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "taxsettings": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreaminfluxdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreamquery": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreamwrite": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transcribe": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transcribeservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transfer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "verifiedpermissions": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "vpclattice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "waf": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wafregional": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wafv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wellarchitected": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "worklink": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "workspaces": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "workspacesweb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "xray": { "type": "string", "description": "Use this to override the default service endpoint URL\n" } }, "type": "object" }, "aws:config/ignoreTags:ignoreTags": { "properties": { "keyPrefixes": { "type": "array", "items": { "type": "string" }, "description": "Resource tag key prefixes to ignore across all resources. Can also be configured with the TF_AWS_IGNORE_TAGS_KEY_PREFIXES environment variable.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Resource tag keys to ignore across all resources. Can also be configured with the TF_AWS_IGNORE_TAGS_KEYS environment variable.\n" } }, "type": "object" }, "aws:connect/BotAssociationLexBot:BotAssociationLexBot": { "properties": { "lexRegion": { "type": "string", "description": "The Region that the Amazon Lex (V1) bot was created in. Defaults to current region.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the Amazon Lex (V1) bot.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "lexRegion", "name" ] } } }, "aws:connect/HoursOfOperationConfig:HoursOfOperationConfig": { "properties": { "day": { "type": "string", "description": "Specifies the day that the hours of operation applies to.\n" }, "endTime": { "$ref": "#/types/aws:connect/HoursOfOperationConfigEndTime:HoursOfOperationConfigEndTime", "description": "A end time block specifies the time that your contact center closes. The `end_time` is documented below.\n" }, "startTime": { "$ref": "#/types/aws:connect/HoursOfOperationConfigStartTime:HoursOfOperationConfigStartTime", "description": "A start time block specifies the time that your contact center opens. The `start_time` is documented below.\n" } }, "type": "object", "required": [ "day", "endTime", "startTime" ] }, "aws:connect/HoursOfOperationConfigEndTime:HoursOfOperationConfigEndTime": { "properties": { "hours": { "type": "integer", "description": "Specifies the hour of closing.\n" }, "minutes": { "type": "integer", "description": "Specifies the minute of closing.\n" } }, "type": "object", "required": [ "hours", "minutes" ] }, "aws:connect/HoursOfOperationConfigStartTime:HoursOfOperationConfigStartTime": { "properties": { "hours": { "type": "integer", "description": "Specifies the hour of opening.\n" }, "minutes": { "type": "integer", "description": "Specifies the minute of opening.\n" } }, "type": "object", "required": [ "hours", "minutes" ] }, "aws:connect/InstanceStorageConfigStorageConfig:InstanceStorageConfigStorageConfig": { "properties": { "kinesisFirehoseConfig": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigKinesisFirehoseConfig:InstanceStorageConfigStorageConfigKinesisFirehoseConfig", "description": "A block that specifies the configuration of the Kinesis Firehose delivery stream. Documented below.\n" }, "kinesisStreamConfig": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigKinesisStreamConfig:InstanceStorageConfigStorageConfigKinesisStreamConfig", "description": "A block that specifies the configuration of the Kinesis data stream. Documented below.\n" }, "kinesisVideoStreamConfig": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigKinesisVideoStreamConfig:InstanceStorageConfigStorageConfigKinesisVideoStreamConfig", "description": "A block that specifies the configuration of the Kinesis video stream. Documented below.\n" }, "s3Config": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigS3Config:InstanceStorageConfigStorageConfigS3Config", "description": "A block that specifies the configuration of S3 Bucket. Documented below.\n" }, "storageType": { "type": "string", "description": "A valid storage type. Valid Values: `S3` | `KINESIS_VIDEO_STREAM` | `KINESIS_STREAM` | `KINESIS_FIREHOSE`.\n" } }, "type": "object", "required": [ "storageType" ] }, "aws:connect/InstanceStorageConfigStorageConfigKinesisFirehoseConfig:InstanceStorageConfigStorageConfigKinesisFirehoseConfig": { "properties": { "firehoseArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the delivery stream.\n" } }, "type": "object", "required": [ "firehoseArn" ] }, "aws:connect/InstanceStorageConfigStorageConfigKinesisStreamConfig:InstanceStorageConfigStorageConfigKinesisStreamConfig": { "properties": { "streamArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the data stream.\n" } }, "type": "object", "required": [ "streamArn" ] }, "aws:connect/InstanceStorageConfigStorageConfigKinesisVideoStreamConfig:InstanceStorageConfigStorageConfigKinesisVideoStreamConfig": { "properties": { "encryptionConfig": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig:InstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig", "description": "The encryption configuration. Documented below.\n" }, "prefix": { "type": "string", "description": "The prefix of the video stream. Minimum length of `1`. Maximum length of `128`. When read from the state, the value returned is `\u003cprefix\u003e-connect-\u003cconnect_instance_alias\u003e-contact-` since the API appends additional details to the `prefix`.\n" }, "retentionPeriodHours": { "type": "integer", "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. Minimum value of `0`. Maximum value of `87600`. A value of `0`, indicates that the stream does not persist data.\n" } }, "type": "object", "required": [ "encryptionConfig", "prefix", "retentionPeriodHours" ] }, "aws:connect/InstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig:InstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig": { "properties": { "encryptionType": { "type": "string", "description": "The type of encryption. Valid Values: `KMS`.\n" }, "keyId": { "type": "string", "description": "The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.\n" } }, "type": "object", "required": [ "encryptionType", "keyId" ] }, "aws:connect/InstanceStorageConfigStorageConfigS3Config:InstanceStorageConfigStorageConfigS3Config": { "properties": { "bucketName": { "type": "string", "description": "The S3 bucket name.\n" }, "bucketPrefix": { "type": "string", "description": "The S3 bucket prefix.\n" }, "encryptionConfig": { "$ref": "#/types/aws:connect/InstanceStorageConfigStorageConfigS3ConfigEncryptionConfig:InstanceStorageConfigStorageConfigS3ConfigEncryptionConfig", "description": "The encryption configuration. Documented below.\n" } }, "type": "object", "required": [ "bucketName", "bucketPrefix" ] }, "aws:connect/InstanceStorageConfigStorageConfigS3ConfigEncryptionConfig:InstanceStorageConfigStorageConfigS3ConfigEncryptionConfig": { "properties": { "encryptionType": { "type": "string", "description": "The type of encryption. Valid Values: `KMS`.\n" }, "keyId": { "type": "string", "description": "The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.\n" } }, "type": "object", "required": [ "encryptionType", "keyId" ] }, "aws:connect/PhoneNumberStatus:PhoneNumberStatus": { "properties": { "message": { "type": "string", "description": "The status message.\n" }, "status": { "type": "string", "description": "The status of the phone number. Valid Values: `CLAIMED` | `IN_PROGRESS` | `FAILED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "status" ] } } }, "aws:connect/QueueOutboundCallerConfig:QueueOutboundCallerConfig": { "properties": { "outboundCallerIdName": { "type": "string", "description": "Specifies the caller ID name.\n" }, "outboundCallerIdNumberId": { "type": "string", "description": "Specifies the caller ID number.\n" }, "outboundFlowId": { "type": "string", "description": "Specifies outbound whisper flow to be used during an outbound call.\n" } }, "type": "object" }, "aws:connect/QuickConnectQuickConnectConfig:QuickConnectQuickConnectConfig": { "properties": { "phoneConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/QuickConnectQuickConnectConfigPhoneConfig:QuickConnectQuickConnectConfigPhoneConfig" }, "description": "Specifies the phone configuration of the Quick Connect. This is required only if `quick_connect_type` is `PHONE_NUMBER`. The `phone_config` block is documented below.\n" }, "queueConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/QuickConnectQuickConnectConfigQueueConfig:QuickConnectQuickConnectConfigQueueConfig" }, "description": "Specifies the queue configuration of the Quick Connect. This is required only if `quick_connect_type` is `QUEUE`. The `queue_config` block is documented below.\n" }, "quickConnectType": { "type": "string", "description": "Specifies the configuration type of the quick connect. valid values are `PHONE_NUMBER`, `QUEUE`, `USER`.\n" }, "userConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/QuickConnectQuickConnectConfigUserConfig:QuickConnectQuickConnectConfigUserConfig" }, "description": "Specifies the user configuration of the Quick Connect. This is required only if `quick_connect_type` is `USER`. The `user_config` block is documented below.\n" } }, "type": "object", "required": [ "quickConnectType" ] }, "aws:connect/QuickConnectQuickConnectConfigPhoneConfig:QuickConnectQuickConnectConfigPhoneConfig": { "properties": { "phoneNumber": { "type": "string", "description": "Specifies the phone number in in E.164 format.\n" } }, "type": "object", "required": [ "phoneNumber" ] }, "aws:connect/QuickConnectQuickConnectConfigQueueConfig:QuickConnectQuickConnectConfigQueueConfig": { "properties": { "contactFlowId": { "type": "string", "description": "Specifies the identifier of the contact flow.\n" }, "queueId": { "type": "string", "description": "Specifies the identifier for the queue.\n" } }, "type": "object", "required": [ "contactFlowId", "queueId" ] }, "aws:connect/QuickConnectQuickConnectConfigUserConfig:QuickConnectQuickConnectConfigUserConfig": { "properties": { "contactFlowId": { "type": "string", "description": "Specifies the identifier of the contact flow.\n" }, "userId": { "type": "string", "description": "Specifies the identifier for the user.\n" } }, "type": "object", "required": [ "contactFlowId", "userId" ] }, "aws:connect/RoutingProfileMediaConcurrency:RoutingProfileMediaConcurrency": { "properties": { "channel": { "type": "string", "description": "Specifies the channels that agents can handle in the Contact Control Panel (CCP). Valid values are `VOICE`, `CHAT`, `TASK`.\n" }, "concurrency": { "type": "integer", "description": "Specifies the number of contacts an agent can have on a channel simultaneously. Valid Range for `VOICE`: Minimum value of 1. Maximum value of 1. Valid Range for `CHAT`: Minimum value of 1. Maximum value of 10. Valid Range for `TASK`: Minimum value of 1. Maximum value of 10.\n" } }, "type": "object", "required": [ "channel", "concurrency" ] }, "aws:connect/RoutingProfileQueueConfig:RoutingProfileQueueConfig": { "properties": { "channel": { "type": "string", "description": "Specifies the channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are `VOICE`, `CHAT`, `TASK`.\n" }, "delay": { "type": "integer", "description": "Specifies the delay, in seconds, that a contact should be in the queue before they are routed to an available agent\n" }, "priority": { "type": "integer", "description": "Specifies the order in which contacts are to be handled for the queue.\n" }, "queueArn": { "type": "string", "description": "ARN for the queue.\n" }, "queueId": { "type": "string", "description": "Specifies the identifier for the queue.\n" }, "queueName": { "type": "string", "description": "Name for the queue.\n" } }, "type": "object", "required": [ "channel", "delay", "priority", "queueId" ], "language": { "nodejs": { "requiredOutputs": [ "channel", "delay", "priority", "queueArn", "queueId", "queueName" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPath:UserHierarchyGroupHierarchyPath": { "properties": { "levelFives": { "type": "array", "items": { "$ref": "#/types/aws:connect/UserHierarchyGroupHierarchyPathLevelFife:UserHierarchyGroupHierarchyPathLevelFife" }, "description": "A block that defines the details of level five. The level block is documented below.\n" }, "levelFours": { "type": "array", "items": { "$ref": "#/types/aws:connect/UserHierarchyGroupHierarchyPathLevelFour:UserHierarchyGroupHierarchyPathLevelFour" }, "description": "A block that defines the details of level four. The level block is documented below.\n" }, "levelOnes": { "type": "array", "items": { "$ref": "#/types/aws:connect/UserHierarchyGroupHierarchyPathLevelOne:UserHierarchyGroupHierarchyPathLevelOne" }, "description": "A block that defines the details of level one. The level block is documented below.\n" }, "levelThrees": { "type": "array", "items": { "$ref": "#/types/aws:connect/UserHierarchyGroupHierarchyPathLevelThree:UserHierarchyGroupHierarchyPathLevelThree" }, "description": "A block that defines the details of level three. The level block is documented below.\n" }, "levelTwos": { "type": "array", "items": { "$ref": "#/types/aws:connect/UserHierarchyGroupHierarchyPathLevelTwo:UserHierarchyGroupHierarchyPathLevelTwo" }, "description": "A block that defines the details of level two. The level block is documented below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "levelFives", "levelFours", "levelOnes", "levelThrees", "levelTwos" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPathLevelFife:UserHierarchyGroupHierarchyPathLevelFife": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy group. Must not be more than 100 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPathLevelFour:UserHierarchyGroupHierarchyPathLevelFour": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy group. Must not be more than 100 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPathLevelOne:UserHierarchyGroupHierarchyPathLevelOne": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy group. Must not be more than 100 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPathLevelThree:UserHierarchyGroupHierarchyPathLevelThree": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy group. Must not be more than 100 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyGroupHierarchyPathLevelTwo:UserHierarchyGroupHierarchyPathLevelTwo": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy group. Must not be more than 100 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructure:UserHierarchyStructureHierarchyStructure": { "properties": { "levelFive": { "$ref": "#/types/aws:connect/UserHierarchyStructureHierarchyStructureLevelFive:UserHierarchyStructureHierarchyStructureLevelFive", "description": "A block that defines the details of level five. The level block is documented below.\n\nEach level block supports the following arguments:\n" }, "levelFour": { "$ref": "#/types/aws:connect/UserHierarchyStructureHierarchyStructureLevelFour:UserHierarchyStructureHierarchyStructureLevelFour", "description": "A block that defines the details of level four. The level block is documented below.\n" }, "levelOne": { "$ref": "#/types/aws:connect/UserHierarchyStructureHierarchyStructureLevelOne:UserHierarchyStructureHierarchyStructureLevelOne", "description": "A block that defines the details of level one. The level block is documented below.\n" }, "levelThree": { "$ref": "#/types/aws:connect/UserHierarchyStructureHierarchyStructureLevelThree:UserHierarchyStructureHierarchyStructureLevelThree", "description": "A block that defines the details of level three. The level block is documented below.\n" }, "levelTwo": { "$ref": "#/types/aws:connect/UserHierarchyStructureHierarchyStructureLevelTwo:UserHierarchyStructureHierarchyStructureLevelTwo", "description": "A block that defines the details of level two. The level block is documented below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "levelFive", "levelFour", "levelOne", "levelThree", "levelTwo" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructureLevelFive:UserHierarchyStructureHierarchyStructureLevelFive": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructureLevelFour:UserHierarchyStructureHierarchyStructureLevelFour": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructureLevelOne:UserHierarchyStructureHierarchyStructureLevelOne": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructureLevelThree:UserHierarchyStructureHierarchyStructureLevelThree": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserHierarchyStructureHierarchyStructureLevelTwo:UserHierarchyStructureHierarchyStructureLevelTwo": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "The name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:connect/UserIdentityInfo:UserIdentityInfo": { "properties": { "email": { "type": "string", "description": "The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the `email` is supported. From the [UpdateUserIdentityInfo API documentation](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateUserIdentityInfo.html) it is strongly recommended to limit who has the ability to invoke `UpdateUserIdentityInfo`. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see [Best Practices for Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the Amazon Connect Administrator Guide.\n" }, "firstName": { "type": "string", "description": "The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.\n" }, "lastName": { "type": "string", "description": "The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.\n" }, "secondaryEmail": { "type": "string", "description": "The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.\n" } }, "type": "object" }, "aws:connect/UserPhoneConfig:UserPhoneConfig": { "properties": { "afterContactWorkTimeLimit": { "type": "integer", "description": "The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.\n" }, "autoAccept": { "type": "boolean", "description": "When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.\n" }, "deskPhoneNumber": { "type": "string", "description": "The phone number for the user's desk phone. Required if `phone_type` is set as `DESK_PHONE`.\n" }, "phoneType": { "type": "string", "description": "The phone type. Valid values are `DESK_PHONE` and `SOFT_PHONE`.\n" } }, "type": "object", "required": [ "phoneType" ] }, "aws:connect/getBotAssociationLexBot:getBotAssociationLexBot": { "properties": { "lexRegion": { "type": "string", "description": "Region that the Amazon Lex (V1) bot was created in.\n" }, "name": { "type": "string", "description": "Name of the Amazon Lex (V1) bot.\n" } }, "type": "object", "required": [ "lexRegion", "name" ], "language": { "nodejs": { "requiredInputs": [ "name" ] } } }, "aws:connect/getHoursOfOperationConfig:getHoursOfOperationConfig": { "properties": { "day": { "type": "string", "description": "Day that the hours of operation applies to.\n" }, "endTimes": { "type": "array", "items": { "$ref": "#/types/aws:connect/getHoursOfOperationConfigEndTime:getHoursOfOperationConfigEndTime" }, "description": "End time block specifies the time that your contact center closes. The `end_time` is documented below.\n" }, "startTimes": { "type": "array", "items": { "$ref": "#/types/aws:connect/getHoursOfOperationConfigStartTime:getHoursOfOperationConfigStartTime" }, "description": "Start time block specifies the time that your contact center opens. The `start_time` is documented below.\n" } }, "type": "object", "required": [ "day", "endTimes", "startTimes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getHoursOfOperationConfigEndTime:getHoursOfOperationConfigEndTime": { "properties": { "hours": { "type": "integer", "description": "Hour of opening.\n" }, "minutes": { "type": "integer", "description": "Minute of opening.\n" } }, "type": "object", "required": [ "hours", "minutes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getHoursOfOperationConfigStartTime:getHoursOfOperationConfigStartTime": { "properties": { "hours": { "type": "integer", "description": "Hour of opening.\n" }, "minutes": { "type": "integer", "description": "Minute of opening.\n" } }, "type": "object", "required": [ "hours", "minutes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfig:getInstanceStorageConfigStorageConfig": { "properties": { "kinesisFirehoseConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigKinesisFirehoseConfig:getInstanceStorageConfigStorageConfigKinesisFirehoseConfig" }, "description": "A block that specifies the configuration of the Kinesis Firehose delivery stream. Documented below.\n" }, "kinesisStreamConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigKinesisStreamConfig:getInstanceStorageConfigStorageConfigKinesisStreamConfig" }, "description": "A block that specifies the configuration of the Kinesis data stream. Documented below.\n" }, "kinesisVideoStreamConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigKinesisVideoStreamConfig:getInstanceStorageConfigStorageConfigKinesisVideoStreamConfig" }, "description": "A block that specifies the configuration of the Kinesis video stream. Documented below.\n" }, "s3Configs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigS3Config:getInstanceStorageConfigStorageConfigS3Config" }, "description": "A block that specifies the configuration of S3 Bucket. Documented below.\n" }, "storageType": { "type": "string", "description": "A valid storage type. Valid Values: `S3` | `KINESIS_VIDEO_STREAM` | `KINESIS_STREAM` | `KINESIS_FIREHOSE`.\n" } }, "type": "object", "required": [ "kinesisFirehoseConfigs", "kinesisStreamConfigs", "kinesisVideoStreamConfigs", "s3Configs", "storageType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigKinesisFirehoseConfig:getInstanceStorageConfigStorageConfigKinesisFirehoseConfig": { "properties": { "firehoseArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the delivery stream.\n" } }, "type": "object", "required": [ "firehoseArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigKinesisStreamConfig:getInstanceStorageConfigStorageConfigKinesisStreamConfig": { "properties": { "streamArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the data stream.\n" } }, "type": "object", "required": [ "streamArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigKinesisVideoStreamConfig:getInstanceStorageConfigStorageConfigKinesisVideoStreamConfig": { "properties": { "encryptionConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig:getInstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig" }, "description": "The encryption configuration. Documented below.\n" }, "prefix": { "type": "string", "description": "The prefix of the video stream. Minimum length of `1`. Maximum length of `128`. When read from the state, the value returned is `\u003cprefix\u003e-connect-\u003cconnect_instance_alias\u003e-contact-` since the API appends additional details to the `prefix`.\n" }, "retentionPeriodHours": { "type": "integer", "description": "The number of hours to retain the data in a data store associated with the stream. Minimum value of `0`. Maximum value of `87600`. A value of `0` indicates that the stream does not persist data.\n" } }, "type": "object", "required": [ "encryptionConfigs", "prefix", "retentionPeriodHours" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig:getInstanceStorageConfigStorageConfigKinesisVideoStreamConfigEncryptionConfig": { "properties": { "encryptionType": { "type": "string", "description": "The type of encryption. Valid Values: `KMS`.\n" }, "keyId": { "type": "string", "description": "The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.\n" } }, "type": "object", "required": [ "encryptionType", "keyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigS3Config:getInstanceStorageConfigStorageConfigS3Config": { "properties": { "bucketName": { "type": "string", "description": "The S3 bucket name.\n" }, "bucketPrefix": { "type": "string", "description": "The S3 bucket prefix.\n" }, "encryptionConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getInstanceStorageConfigStorageConfigS3ConfigEncryptionConfig:getInstanceStorageConfigStorageConfigS3ConfigEncryptionConfig" }, "description": "The encryption configuration. Documented below.\n" } }, "type": "object", "required": [ "bucketName", "bucketPrefix", "encryptionConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getInstanceStorageConfigStorageConfigS3ConfigEncryptionConfig:getInstanceStorageConfigStorageConfigS3ConfigEncryptionConfig": { "properties": { "encryptionType": { "type": "string", "description": "The type of encryption. Valid Values: `KMS`.\n" }, "keyId": { "type": "string", "description": "The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.\n" } }, "type": "object", "required": [ "encryptionType", "keyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getQueueOutboundCallerConfig:getQueueOutboundCallerConfig": { "properties": { "outboundCallerIdName": { "type": "string", "description": "Specifies the caller ID name.\n" }, "outboundCallerIdNumberId": { "type": "string", "description": "Specifies the caller ID number.\n" }, "outboundFlowId": { "type": "string", "description": "Outbound whisper flow to be used during an outbound call.\n" } }, "type": "object", "required": [ "outboundCallerIdName", "outboundCallerIdNumberId", "outboundFlowId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getQuickConnectQuickConnectConfig:getQuickConnectQuickConnectConfig": { "properties": { "phoneConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getQuickConnectQuickConnectConfigPhoneConfig:getQuickConnectQuickConnectConfigPhoneConfig" }, "description": "Phone configuration of the Quick Connect. This is returned only if `quick_connect_type` is `PHONE_NUMBER`. The `phone_config` block is documented below.\n" }, "queueConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getQuickConnectQuickConnectConfigQueueConfig:getQuickConnectQuickConnectConfigQueueConfig" }, "description": "Queue configuration of the Quick Connect. This is returned only if `quick_connect_type` is `QUEUE`. The `queue_config` block is documented below.\n" }, "quickConnectType": { "type": "string", "description": "Configuration type of the Quick Connect. Valid values are `PHONE_NUMBER`, `QUEUE`, `USER`.\n" }, "userConfigs": { "type": "array", "items": { "$ref": "#/types/aws:connect/getQuickConnectQuickConnectConfigUserConfig:getQuickConnectQuickConnectConfigUserConfig" }, "description": "User configuration of the Quick Connect. This is returned only if `quick_connect_type` is `USER`. The `user_config` block is documented below.\n" } }, "type": "object", "required": [ "phoneConfigs", "queueConfigs", "quickConnectType", "userConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getQuickConnectQuickConnectConfigPhoneConfig:getQuickConnectQuickConnectConfigPhoneConfig": { "properties": { "phoneNumber": { "type": "string", "description": "Phone number in in E.164 format.\n" } }, "type": "object", "required": [ "phoneNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getQuickConnectQuickConnectConfigQueueConfig:getQuickConnectQuickConnectConfigQueueConfig": { "properties": { "contactFlowId": { "type": "string", "description": "Identifier of the contact flow.\n" }, "queueId": { "type": "string", "description": "Identifier for the queue.\n" } }, "type": "object", "required": [ "contactFlowId", "queueId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getQuickConnectQuickConnectConfigUserConfig:getQuickConnectQuickConnectConfigUserConfig": { "properties": { "contactFlowId": { "type": "string", "description": "Identifier of the contact flow.\n" }, "userId": { "type": "string", "description": "Identifier for the user.\n" } }, "type": "object", "required": [ "contactFlowId", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getRoutingProfileMediaConcurrency:getRoutingProfileMediaConcurrency": { "properties": { "channel": { "type": "string", "description": "Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are `VOICE`, `CHAT`, `TASK`.\n" }, "concurrency": { "type": "integer", "description": "Number of contacts an agent can have on a channel simultaneously. Valid Range for `VOICE`: Minimum value of 1. Maximum value of 1. Valid Range for `CHAT`: Minimum value of 1. Maximum value of 10. Valid Range for `TASK`: Minimum value of 1. Maximum value of 10.\n" } }, "type": "object", "required": [ "channel", "concurrency" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getRoutingProfileQueueConfig:getRoutingProfileQueueConfig": { "properties": { "channel": { "type": "string", "description": "Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are `VOICE`, `CHAT`, `TASK`.\n" }, "delay": { "type": "integer", "description": "Delay, in seconds, that a contact should be in the queue before they are routed to an available agent\n" }, "priority": { "type": "integer", "description": "Order in which contacts are to be handled for the queue.\n" }, "queueArn": { "type": "string", "description": "ARN for the queue.\n" }, "queueId": { "type": "string", "description": "Identifier for the queue.\n" }, "queueName": { "type": "string", "description": "Name for the queue.\n" } }, "type": "object", "required": [ "channel", "delay", "priority", "queueArn", "queueId", "queueName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPath:getUserHierarchyGroupHierarchyPath": { "properties": { "levelFives": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyGroupHierarchyPathLevelFife:getUserHierarchyGroupHierarchyPathLevelFife" }, "description": "Details of level five. See below.\n" }, "levelFours": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyGroupHierarchyPathLevelFour:getUserHierarchyGroupHierarchyPathLevelFour" }, "description": "Details of level four. See below.\n" }, "levelOnes": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyGroupHierarchyPathLevelOne:getUserHierarchyGroupHierarchyPathLevelOne" }, "description": "Details of level one. See below.\n" }, "levelThrees": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyGroupHierarchyPathLevelThree:getUserHierarchyGroupHierarchyPathLevelThree" }, "description": "Details of level three. See below.\n" }, "levelTwos": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyGroupHierarchyPathLevelTwo:getUserHierarchyGroupHierarchyPathLevelTwo" }, "description": "Details of level two. See below.\n" } }, "type": "object", "required": [ "levelFives", "levelFours", "levelOnes", "levelThrees", "levelTwos" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPathLevelFife:getUserHierarchyGroupHierarchyPathLevelFife": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "Returns information on a specific hierarchy group by name\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPathLevelFour:getUserHierarchyGroupHierarchyPathLevelFour": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "Returns information on a specific hierarchy group by name\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPathLevelOne:getUserHierarchyGroupHierarchyPathLevelOne": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "Returns information on a specific hierarchy group by name\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPathLevelThree:getUserHierarchyGroupHierarchyPathLevelThree": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "Returns information on a specific hierarchy group by name\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyGroupHierarchyPathLevelTwo:getUserHierarchyGroupHierarchyPathLevelTwo": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy group.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy group.\n" }, "name": { "type": "string", "description": "Returns information on a specific hierarchy group by name\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructure:getUserHierarchyStructureHierarchyStructure": { "properties": { "levelFives": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyStructureHierarchyStructureLevelFife:getUserHierarchyStructureHierarchyStructureLevelFife" }, "description": "Details of level five. See below.\n" }, "levelFours": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyStructureHierarchyStructureLevelFour:getUserHierarchyStructureHierarchyStructureLevelFour" }, "description": "Details of level four. See below.\n" }, "levelOnes": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyStructureHierarchyStructureLevelOne:getUserHierarchyStructureHierarchyStructureLevelOne" }, "description": "Details of level one. See below.\n" }, "levelThrees": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyStructureHierarchyStructureLevelThree:getUserHierarchyStructureHierarchyStructureLevelThree" }, "description": "Details of level three. See below.\n" }, "levelTwos": { "type": "array", "items": { "$ref": "#/types/aws:connect/getUserHierarchyStructureHierarchyStructureLevelTwo:getUserHierarchyStructureHierarchyStructureLevelTwo" }, "description": "Details of level two. See below.\n" } }, "type": "object", "required": [ "levelFives", "levelFours", "levelOnes", "levelThrees", "levelTwos" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructureLevelFife:getUserHierarchyStructureHierarchyStructureLevelFife": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "Name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructureLevelFour:getUserHierarchyStructureHierarchyStructureLevelFour": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "Name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructureLevelOne:getUserHierarchyStructureHierarchyStructureLevelOne": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "Name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructureLevelThree:getUserHierarchyStructureHierarchyStructureLevelThree": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "Name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserHierarchyStructureHierarchyStructureLevelTwo:getUserHierarchyStructureHierarchyStructureLevelTwo": { "properties": { "arn": { "type": "string", "description": "ARN of the hierarchy level.\n" }, "id": { "type": "string", "description": "The identifier of the hierarchy level.\n" }, "name": { "type": "string", "description": "Name of the user hierarchy level. Must not be more than 50 characters.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserIdentityInfo:getUserIdentityInfo": { "properties": { "email": { "type": "string", "description": "The email address.\n" }, "firstName": { "type": "string", "description": "The first name.\n" }, "lastName": { "type": "string", "description": "The last name.\n" }, "secondaryEmail": { "type": "string", "description": "The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.\n" } }, "type": "object", "required": [ "email", "firstName", "lastName", "secondaryEmail" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:connect/getUserPhoneConfig:getUserPhoneConfig": { "properties": { "afterContactWorkTimeLimit": { "type": "integer", "description": "The After Call Work (ACW) timeout setting, in seconds.\n" }, "autoAccept": { "type": "boolean", "description": "When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.\n" }, "deskPhoneNumber": { "type": "string", "description": "The phone number for the user's desk phone.\n" }, "phoneType": { "type": "string", "description": "The phone type. Valid values are `DESK_PHONE` and `SOFT_PHONE`.\n" } }, "type": "object", "required": [ "afterContactWorkTimeLimit", "autoAccept", "deskPhoneNumber", "phoneType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:controltower/ControlTowerControlParameter:ControlTowerControlParameter": { "properties": { "key": { "type": "string", "description": "The name of the parameter.\n" }, "value": { "type": "string", "description": "The value of the parameter.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:controltower/LandingZoneDriftStatus:LandingZoneDriftStatus": { "properties": { "status": { "type": "string", "description": "The drift status of the landing zone.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "status" ] } } }, "aws:costexplorer/AnomalySubscriptionSubscriber:AnomalySubscriptionSubscriber": { "properties": { "address": { "type": "string", "description": "The address of the subscriber. If type is `SNS`, this will be the arn of the sns topic. If type is `EMAIL`, this will be the destination email address.\n" }, "type": { "type": "string", "description": "The type of subscription. Valid Values: `SNS` | `EMAIL`.\n" } }, "type": "object", "required": [ "address", "type" ] }, "aws:costexplorer/AnomalySubscriptionThresholdExpression:AnomalySubscriptionThresholdExpression": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionAnd:AnomalySubscriptionThresholdExpressionAnd" }, "description": "Return results that match both Dimension objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionCostCategory:AnomalySubscriptionThresholdExpressionCostCategory", "description": "Configuration block for the filter that's based on values. See Cost Category below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionDimension:AnomalySubscriptionThresholdExpressionDimension", "description": "Configuration block for the specific Dimension to use for.\n" }, "not": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionNot:AnomalySubscriptionThresholdExpressionNot", "description": "Return results that do not match the Dimension object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionOr:AnomalySubscriptionThresholdExpressionOr" }, "description": "Return results that match either Dimension object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionTags:AnomalySubscriptionThresholdExpressionTags", "description": "Configuration block for the specific Tag to use for. See Tags below.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionAnd:AnomalySubscriptionThresholdExpressionAnd": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionAndCostCategory:AnomalySubscriptionThresholdExpressionAndCostCategory", "description": "Configuration block for the filter that's based on values. See Cost Category below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionAndDimension:AnomalySubscriptionThresholdExpressionAndDimension", "description": "Configuration block for the specific Dimension to use for.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionAndTags:AnomalySubscriptionThresholdExpressionAndTags", "description": "A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionAndCostCategory:AnomalySubscriptionThresholdExpressionAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionAndDimension:AnomalySubscriptionThresholdExpressionAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionAndTags:AnomalySubscriptionThresholdExpressionAndTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionCostCategory:AnomalySubscriptionThresholdExpressionCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionDimension:AnomalySubscriptionThresholdExpressionDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionNot:AnomalySubscriptionThresholdExpressionNot": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionNotCostCategory:AnomalySubscriptionThresholdExpressionNotCostCategory", "description": "Configuration block for the filter that's based on values. See Cost Category below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionNotDimension:AnomalySubscriptionThresholdExpressionNotDimension", "description": "Configuration block for the specific Dimension to use for.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionNotTags:AnomalySubscriptionThresholdExpressionNotTags", "description": "A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionNotCostCategory:AnomalySubscriptionThresholdExpressionNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionNotDimension:AnomalySubscriptionThresholdExpressionNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionNotTags:AnomalySubscriptionThresholdExpressionNotTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionOr:AnomalySubscriptionThresholdExpressionOr": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionOrCostCategory:AnomalySubscriptionThresholdExpressionOrCostCategory", "description": "Configuration block for the filter that's based on values. See Cost Category below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionOrDimension:AnomalySubscriptionThresholdExpressionOrDimension", "description": "Configuration block for the specific Dimension to use for.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/AnomalySubscriptionThresholdExpressionOrTags:AnomalySubscriptionThresholdExpressionOrTags", "description": "A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionOrCostCategory:AnomalySubscriptionThresholdExpressionOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionOrDimension:AnomalySubscriptionThresholdExpressionOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionOrTags:AnomalySubscriptionThresholdExpressionOrTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/AnomalySubscriptionThresholdExpressionTags:AnomalySubscriptionThresholdExpressionTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRule:CostCategoryRule": { "properties": { "inheritedValue": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleInheritedValue:CostCategoryRuleInheritedValue", "description": "Configuration block for the value the line item is categorized as if the line item contains the matched dimension. See below.\n" }, "rule": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRule:CostCategoryRuleRule", "description": "Configuration block for the `Expression` object used to categorize costs. See below.\n" }, "type": { "type": "string", "description": "You can define the CostCategoryRule rule type as either `REGULAR` or `INHERITED_VALUE`.\n" }, "value": { "type": "string", "description": "Default value for the cost category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleInheritedValue:CostCategoryRuleInheritedValue": { "properties": { "dimensionKey": { "type": "string", "description": "Key to extract cost category values.\n" }, "dimensionName": { "type": "string", "description": "Name of the dimension that's used to group costs. If you specify `LINKED_ACCOUNT_NAME`, the cost category value is based on account name. If you specify `TAG`, the cost category value will be based on the value of the specified tag key. Valid values are `LINKED_ACCOUNT_NAME`, `TAG`\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRule:CostCategoryRuleRule": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAnd:CostCategoryRuleRuleAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleCostCategory:CostCategoryRuleRuleCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleDimension:CostCategoryRuleRuleDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "not": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNot:CostCategoryRuleRuleNot", "description": "Return results that match both `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOr:CostCategoryRuleRuleOr" }, "description": "Return results that match both `Dimension` object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleTags:CostCategoryRuleRuleTags", "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAnd:CostCategoryRuleRuleAnd": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndAnd:CostCategoryRuleRuleAndAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndCostCategory:CostCategoryRuleRuleAndCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndDimension:CostCategoryRuleRuleAndDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "not": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndNot:CostCategoryRuleRuleAndNot", "description": "Return results that match both `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndOr:CostCategoryRuleRuleAndOr" }, "description": "Return results that match both `Dimension` object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndTags:CostCategoryRuleRuleAndTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndAnd:CostCategoryRuleRuleAndAnd": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndAndCostCategory:CostCategoryRuleRuleAndAndCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndAndDimension:CostCategoryRuleRuleAndAndDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndAndTags:CostCategoryRuleRuleAndAndTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndAndCostCategory:CostCategoryRuleRuleAndAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndAndDimension:CostCategoryRuleRuleAndAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndAndTags:CostCategoryRuleRuleAndAndTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndCostCategory:CostCategoryRuleRuleAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndDimension:CostCategoryRuleRuleAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndNot:CostCategoryRuleRuleAndNot": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndNotCostCategory:CostCategoryRuleRuleAndNotCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndNotDimension:CostCategoryRuleRuleAndNotDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndNotTags:CostCategoryRuleRuleAndNotTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndNotCostCategory:CostCategoryRuleRuleAndNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndNotDimension:CostCategoryRuleRuleAndNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndNotTags:CostCategoryRuleRuleAndNotTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndOr:CostCategoryRuleRuleAndOr": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndOrCostCategory:CostCategoryRuleRuleAndOrCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndOrDimension:CostCategoryRuleRuleAndOrDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleAndOrTags:CostCategoryRuleRuleAndOrTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndOrCostCategory:CostCategoryRuleRuleAndOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndOrDimension:CostCategoryRuleRuleAndOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndOrTags:CostCategoryRuleRuleAndOrTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleAndTags:CostCategoryRuleRuleAndTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleCostCategory:CostCategoryRuleRuleCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleDimension:CostCategoryRuleRuleDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNot:CostCategoryRuleRuleNot": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotAnd:CostCategoryRuleRuleNotAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotCostCategory:CostCategoryRuleRuleNotCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotDimension:CostCategoryRuleRuleNotDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "not": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotNot:CostCategoryRuleRuleNotNot", "description": "Return results that match both `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotOr:CostCategoryRuleRuleNotOr" }, "description": "Return results that match both `Dimension` object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotTags:CostCategoryRuleRuleNotTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotAnd:CostCategoryRuleRuleNotAnd": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotAndCostCategory:CostCategoryRuleRuleNotAndCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotAndDimension:CostCategoryRuleRuleNotAndDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotAndTags:CostCategoryRuleRuleNotAndTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotAndCostCategory:CostCategoryRuleRuleNotAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotAndDimension:CostCategoryRuleRuleNotAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotAndTags:CostCategoryRuleRuleNotAndTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotCostCategory:CostCategoryRuleRuleNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotDimension:CostCategoryRuleRuleNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotNot:CostCategoryRuleRuleNotNot": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotNotCostCategory:CostCategoryRuleRuleNotNotCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotNotDimension:CostCategoryRuleRuleNotNotDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotNotTags:CostCategoryRuleRuleNotNotTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotNotCostCategory:CostCategoryRuleRuleNotNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotNotDimension:CostCategoryRuleRuleNotNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotNotTags:CostCategoryRuleRuleNotNotTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotOr:CostCategoryRuleRuleNotOr": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotOrCostCategory:CostCategoryRuleRuleNotOrCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotOrDimension:CostCategoryRuleRuleNotOrDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleNotOrTags:CostCategoryRuleRuleNotOrTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotOrCostCategory:CostCategoryRuleRuleNotOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotOrDimension:CostCategoryRuleRuleNotOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotOrTags:CostCategoryRuleRuleNotOrTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleNotTags:CostCategoryRuleRuleNotTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOr:CostCategoryRuleRuleOr": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrAnd:CostCategoryRuleRuleOrAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrCostCategory:CostCategoryRuleRuleOrCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrDimension:CostCategoryRuleRuleOrDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "not": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrNot:CostCategoryRuleRuleOrNot", "description": "Return results that match both `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrOr:CostCategoryRuleRuleOrOr" }, "description": "Return results that match both `Dimension` object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrTags:CostCategoryRuleRuleOrTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrAnd:CostCategoryRuleRuleOrAnd": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrAndCostCategory:CostCategoryRuleRuleOrAndCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrAndDimension:CostCategoryRuleRuleOrAndDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrAndTags:CostCategoryRuleRuleOrAndTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrAndCostCategory:CostCategoryRuleRuleOrAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrAndDimension:CostCategoryRuleRuleOrAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrAndTags:CostCategoryRuleRuleOrAndTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrCostCategory:CostCategoryRuleRuleOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrDimension:CostCategoryRuleRuleOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrNot:CostCategoryRuleRuleOrNot": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrNotCostCategory:CostCategoryRuleRuleOrNotCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrNotDimension:CostCategoryRuleRuleOrNotDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrNotTags:CostCategoryRuleRuleOrNotTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrNotCostCategory:CostCategoryRuleRuleOrNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrNotDimension:CostCategoryRuleRuleOrNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrNotTags:CostCategoryRuleRuleOrNotTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrOr:CostCategoryRuleRuleOrOr": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrOrCostCategory:CostCategoryRuleRuleOrOrCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrOrDimension:CostCategoryRuleRuleOrOrDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/CostCategoryRuleRuleOrOrTags:CostCategoryRuleRuleOrOrTags", "description": "Key-value mapping of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrOrCostCategory:CostCategoryRuleRuleOrOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrOrDimension:CostCategoryRuleRuleOrOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrOrTags:CostCategoryRuleRuleOrOrTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleOrTags:CostCategoryRuleRuleOrTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategoryRuleRuleTags:CostCategoryRuleRuleTags": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/CostCategorySplitChargeRule:CostCategorySplitChargeRule": { "properties": { "method": { "type": "string", "description": "Method that's used to define how to split your source costs across your targets. Valid values are `FIXED`, `PROPORTIONAL`, `EVEN`\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/CostCategorySplitChargeRuleParameter:CostCategorySplitChargeRuleParameter" }, "description": "Configuration block for the parameters for a split charge method. This is only required for the `FIXED` method. See below.\n" }, "source": { "type": "string", "description": "Cost Category value that you want to split.\n" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.\n" } }, "type": "object", "required": [ "method", "source", "targets" ] }, "aws:costexplorer/CostCategorySplitChargeRuleParameter:CostCategorySplitChargeRuleParameter": { "properties": { "type": { "type": "string", "description": "Parameter type.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object" }, "aws:costexplorer/getCostCategoryRule:getCostCategoryRule": { "properties": { "inheritedValues": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleInheritedValue:getCostCategoryRuleInheritedValue" }, "description": "Configuration block for the value the line item is categorized as if the line item contains the matched dimension. See below.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRule:getCostCategoryRuleRule" }, "description": "Configuration block for the `Expression` object used to categorize costs. See below.\n" }, "type": { "type": "string", "description": "Parameter type.\n" }, "value": { "type": "string", "description": "Default value for the cost category.\n" } }, "type": "object", "required": [ "inheritedValues", "rules", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleInheritedValue:getCostCategoryRuleInheritedValue": { "properties": { "dimensionKey": { "type": "string", "description": "Key to extract cost category values.\n" }, "dimensionName": { "type": "string", "description": "Name of the dimension that's used to group costs. If you specify `LINKED_ACCOUNT_NAME`, the cost category value is based on account name. If you specify `TAG`, the cost category value will be based on the value of the specified tag key. Valid values are `LINKED_ACCOUNT_NAME`, `TAG`\n" } }, "type": "object", "required": [ "dimensionKey", "dimensionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRule:getCostCategoryRuleRule": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAnd:getCostCategoryRuleRuleAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleCostCategory:getCostCategoryRuleRuleCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleDimension:getCostCategoryRuleRuleDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "nots": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNot:getCostCategoryRuleRuleNot" }, "description": "Return results that do not match the `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOr:getCostCategoryRuleRuleOr" }, "description": "Return results that match either `Dimension` object.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleTag:getCostCategoryRuleRuleTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "ands", "costCategories", "dimensions", "nots", "ors", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAnd:getCostCategoryRuleRuleAnd": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndAnd:getCostCategoryRuleRuleAndAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndCostCategory:getCostCategoryRuleRuleAndCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndDimension:getCostCategoryRuleRuleAndDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "nots": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndNot:getCostCategoryRuleRuleAndNot" }, "description": "Return results that do not match the `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndOr:getCostCategoryRuleRuleAndOr" }, "description": "Return results that match either `Dimension` object.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndTag:getCostCategoryRuleRuleAndTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "ands", "costCategories", "dimensions", "nots", "ors", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndAnd:getCostCategoryRuleRuleAndAnd": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndAndCostCategory:getCostCategoryRuleRuleAndAndCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndAndDimension:getCostCategoryRuleRuleAndAndDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndAndTag:getCostCategoryRuleRuleAndAndTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndAndCostCategory:getCostCategoryRuleRuleAndAndCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndAndDimension:getCostCategoryRuleRuleAndAndDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndAndTag:getCostCategoryRuleRuleAndAndTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndCostCategory:getCostCategoryRuleRuleAndCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndDimension:getCostCategoryRuleRuleAndDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndNot:getCostCategoryRuleRuleAndNot": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndNotCostCategory:getCostCategoryRuleRuleAndNotCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndNotDimension:getCostCategoryRuleRuleAndNotDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndNotTag:getCostCategoryRuleRuleAndNotTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndNotCostCategory:getCostCategoryRuleRuleAndNotCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndNotDimension:getCostCategoryRuleRuleAndNotDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndNotTag:getCostCategoryRuleRuleAndNotTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndOr:getCostCategoryRuleRuleAndOr": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndOrCostCategory:getCostCategoryRuleRuleAndOrCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndOrDimension:getCostCategoryRuleRuleAndOrDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleAndOrTag:getCostCategoryRuleRuleAndOrTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndOrCostCategory:getCostCategoryRuleRuleAndOrCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndOrDimension:getCostCategoryRuleRuleAndOrDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndOrTag:getCostCategoryRuleRuleAndOrTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleAndTag:getCostCategoryRuleRuleAndTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleCostCategory:getCostCategoryRuleRuleCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleDimension:getCostCategoryRuleRuleDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNot:getCostCategoryRuleRuleNot": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotAnd:getCostCategoryRuleRuleNotAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotCostCategory:getCostCategoryRuleRuleNotCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotDimension:getCostCategoryRuleRuleNotDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "nots": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotNot:getCostCategoryRuleRuleNotNot" }, "description": "Return results that do not match the `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotOr:getCostCategoryRuleRuleNotOr" }, "description": "Return results that match either `Dimension` object.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotTag:getCostCategoryRuleRuleNotTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "ands", "costCategories", "dimensions", "nots", "ors", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotAnd:getCostCategoryRuleRuleNotAnd": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotAndCostCategory:getCostCategoryRuleRuleNotAndCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotAndDimension:getCostCategoryRuleRuleNotAndDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotAndTag:getCostCategoryRuleRuleNotAndTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotAndCostCategory:getCostCategoryRuleRuleNotAndCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotAndDimension:getCostCategoryRuleRuleNotAndDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotAndTag:getCostCategoryRuleRuleNotAndTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotCostCategory:getCostCategoryRuleRuleNotCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotDimension:getCostCategoryRuleRuleNotDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotNot:getCostCategoryRuleRuleNotNot": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotNotCostCategory:getCostCategoryRuleRuleNotNotCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotNotDimension:getCostCategoryRuleRuleNotNotDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotNotTag:getCostCategoryRuleRuleNotNotTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotNotCostCategory:getCostCategoryRuleRuleNotNotCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotNotDimension:getCostCategoryRuleRuleNotNotDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotNotTag:getCostCategoryRuleRuleNotNotTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotOr:getCostCategoryRuleRuleNotOr": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotOrCostCategory:getCostCategoryRuleRuleNotOrCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotOrDimension:getCostCategoryRuleRuleNotOrDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleNotOrTag:getCostCategoryRuleRuleNotOrTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotOrCostCategory:getCostCategoryRuleRuleNotOrCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotOrDimension:getCostCategoryRuleRuleNotOrDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotOrTag:getCostCategoryRuleRuleNotOrTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleNotTag:getCostCategoryRuleRuleNotTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOr:getCostCategoryRuleRuleOr": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrAnd:getCostCategoryRuleRuleOrAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrCostCategory:getCostCategoryRuleRuleOrCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrDimension:getCostCategoryRuleRuleOrDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "nots": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrNot:getCostCategoryRuleRuleOrNot" }, "description": "Return results that do not match the `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrOr:getCostCategoryRuleRuleOrOr" }, "description": "Return results that match either `Dimension` object.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrTag:getCostCategoryRuleRuleOrTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "ands", "costCategories", "dimensions", "nots", "ors", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrAnd:getCostCategoryRuleRuleOrAnd": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrAndCostCategory:getCostCategoryRuleRuleOrAndCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrAndDimension:getCostCategoryRuleRuleOrAndDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrAndTag:getCostCategoryRuleRuleOrAndTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrAndCostCategory:getCostCategoryRuleRuleOrAndCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrAndDimension:getCostCategoryRuleRuleOrAndDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrAndTag:getCostCategoryRuleRuleOrAndTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrCostCategory:getCostCategoryRuleRuleOrCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrDimension:getCostCategoryRuleRuleOrDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrNot:getCostCategoryRuleRuleOrNot": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrNotCostCategory:getCostCategoryRuleRuleOrNotCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrNotDimension:getCostCategoryRuleRuleOrNotDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrNotTag:getCostCategoryRuleRuleOrNotTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrNotCostCategory:getCostCategoryRuleRuleOrNotCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrNotDimension:getCostCategoryRuleRuleOrNotDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrNotTag:getCostCategoryRuleRuleOrNotTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrOr:getCostCategoryRuleRuleOrOr": { "properties": { "costCategories": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrOrCostCategory:getCostCategoryRuleRuleOrOrCostCategory" }, "description": "Configuration block for the filter that's based on `CostCategory` values. See below.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrOrDimension:getCostCategoryRuleRuleOrOrDimension" }, "description": "Configuration block for the specific `Dimension` to use for `Expression`. See below.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategoryRuleRuleOrOrTag:getCostCategoryRuleRuleOrOrTag" }, "description": "Configuration block for the specific `Tag` to use for `Expression`. See below.\n" } }, "type": "object", "required": [ "costCategories", "dimensions", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrOrCostCategory:getCostCategoryRuleRuleOrOrCostCategory": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrOrDimension:getCostCategoryRuleRuleOrOrDimension": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrOrTag:getCostCategoryRuleRuleOrOrTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleOrTag:getCostCategoryRuleRuleOrTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategoryRuleRuleTag:getCostCategoryRuleRuleTag": { "properties": { "key": { "type": "string", "description": "Key for the tag.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "key", "matchOptions", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategorySplitChargeRule:getCostCategorySplitChargeRule": { "properties": { "method": { "type": "string", "description": "Method that's used to define how to split your source costs across your targets. Valid values are `FIXED`, `PROPORTIONAL`, `EVEN`\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getCostCategorySplitChargeRuleParameter:getCostCategorySplitChargeRuleParameter" }, "description": "Configuration block for the parameters for a split charge method. This is only required for the `FIXED` method. See below.\n" }, "source": { "type": "string", "description": "Cost Category value that you want to split.\n" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.\n" } }, "type": "object", "required": [ "method", "parameters", "source", "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getCostCategorySplitChargeRuleParameter:getCostCategorySplitChargeRuleParameter": { "properties": { "type": { "type": "string", "description": "Parameter type.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values.\n" } }, "type": "object", "required": [ "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:costexplorer/getTagsFilter:getTagsFilter": { "properties": { "ands": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getTagsFilterAnd:getTagsFilterAnd" }, "description": "Return results that match both `Dimension` objects.\n" }, "costCategory": { "$ref": "#/types/aws:costexplorer/getTagsFilterCostCategory:getTagsFilterCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See `cost_category` block below for details.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/getTagsFilterDimension:getTagsFilterDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See `dimension` block below for details.\n" }, "not": { "$ref": "#/types/aws:costexplorer/getTagsFilterNot:getTagsFilterNot", "description": "Return results that match both `Dimension` object.\n" }, "ors": { "type": "array", "items": { "$ref": "#/types/aws:costexplorer/getTagsFilterOr:getTagsFilterOr" }, "description": "Return results that match both `Dimension` object.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/getTagsFilterTags:getTagsFilterTags", "description": "Tags that match your request.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterAnd:getTagsFilterAnd": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/getTagsFilterAndCostCategory:getTagsFilterAndCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See `cost_category` block below for details.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/getTagsFilterAndDimension:getTagsFilterAndDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See `dimension` block below for details.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/getTagsFilterAndTags:getTagsFilterAndTags", "description": "Tags that match your request.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterAndCostCategory:getTagsFilterAndCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterAndDimension:getTagsFilterAndDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterAndTags:getTagsFilterAndTags": { "properties": { "key": { "type": "string" }, "matchOptions": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:costexplorer/getTagsFilterCostCategory:getTagsFilterCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterDimension:getTagsFilterDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterNot:getTagsFilterNot": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/getTagsFilterNotCostCategory:getTagsFilterNotCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See `cost_category` block below for details.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/getTagsFilterNotDimension:getTagsFilterNotDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See `dimension` block below for details.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/getTagsFilterNotTags:getTagsFilterNotTags", "description": "Tags that match your request.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterNotCostCategory:getTagsFilterNotCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterNotDimension:getTagsFilterNotDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterNotTags:getTagsFilterNotTags": { "properties": { "key": { "type": "string" }, "matchOptions": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:costexplorer/getTagsFilterOr:getTagsFilterOr": { "properties": { "costCategory": { "$ref": "#/types/aws:costexplorer/getTagsFilterOrCostCategory:getTagsFilterOrCostCategory", "description": "Configuration block for the filter that's based on `CostCategory` values. See `cost_category` block below for details.\n" }, "dimension": { "$ref": "#/types/aws:costexplorer/getTagsFilterOrDimension:getTagsFilterOrDimension", "description": "Configuration block for the specific `Dimension` to use for `Expression`. See `dimension` block below for details.\n" }, "tags": { "$ref": "#/types/aws:costexplorer/getTagsFilterOrTags:getTagsFilterOrTags", "description": "Tags that match your request.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterOrCostCategory:getTagsFilterOrCostCategory": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterOrDimension:getTagsFilterOrDimension": { "properties": { "key": { "type": "string", "description": "Unique name of the Cost Category.\n" }, "matchOptions": { "type": "array", "items": { "type": "string" }, "description": "Match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is `EQUALS` and `CASE_SENSITIVE`. Valid values are: `EQUALS`, `ABSENT`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CASE_SENSITIVE`, `CASE_INSENSITIVE`.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specific value of the Cost Category.\n" } }, "type": "object" }, "aws:costexplorer/getTagsFilterOrTags:getTagsFilterOrTags": { "properties": { "key": { "type": "string" }, "matchOptions": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:costexplorer/getTagsFilterTags:getTagsFilterTags": { "properties": { "key": { "type": "string" }, "matchOptions": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:costexplorer/getTagsSortBy:getTagsSortBy": { "properties": { "key": { "type": "string", "description": "key that's used to sort the data. Valid values are: `BlendedCost`, `UnblendedCost`, `AmortizedCost`, `NetAmortizedCost`, `NetUnblendedCost`, `UsageQuantity`, `NormalizedUsageAmount`.\n" }, "sortOrder": { "type": "string", "description": "order that's used to sort the data. Valid values are: `ASCENDING`, `DESCENDING`.\n" } }, "type": "object" }, "aws:costexplorer/getTagsTimePeriod:getTagsTimePeriod": { "properties": { "end": { "type": "string", "description": "Beginning of the time period.\n" }, "start": { "type": "string", "description": "End of the time period.\n" } }, "type": "object", "required": [ "end", "start" ] }, "aws:customerprofiles/DomainMatching:DomainMatching": { "properties": { "autoMerging": { "$ref": "#/types/aws:customerprofiles/DomainMatchingAutoMerging:DomainMatchingAutoMerging", "description": "A block that specifies the configuration about the auto-merging process. Documented below.\n" }, "enabled": { "type": "boolean", "description": "The flag that enables the matching process of duplicate profiles.\n" }, "exportingConfig": { "$ref": "#/types/aws:customerprofiles/DomainMatchingExportingConfig:DomainMatchingExportingConfig", "description": "A block that specifies the configuration for exporting Identity Resolution results. Documented below.\n" }, "jobSchedule": { "$ref": "#/types/aws:customerprofiles/DomainMatchingJobSchedule:DomainMatchingJobSchedule", "description": "A block that specifies the day and time when you want to start the Identity Resolution Job every week. Documented below.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "autoMerging", "enabled" ] } } }, "aws:customerprofiles/DomainMatchingAutoMerging:DomainMatchingAutoMerging": { "properties": { "conflictResolution": { "$ref": "#/types/aws:customerprofiles/DomainMatchingAutoMergingConflictResolution:DomainMatchingAutoMergingConflictResolution", "description": "A block that specifies how the auto-merging process should resolve conflicts between different profiles. Documented below.\n" }, "consolidation": { "$ref": "#/types/aws:customerprofiles/DomainMatchingAutoMergingConsolidation:DomainMatchingAutoMergingConsolidation", "description": "A block that specifies 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. Documented below.\n* `min_allowed_confidence_score_for_merging ` - (Optional) 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.\n" }, "enabled": { "type": "boolean", "description": "The flag that enables the auto-merging of duplicate profiles.\n" }, "minAllowedConfidenceScoreForMerging": { "type": "number" } }, "type": "object", "required": [ "enabled" ] }, "aws:customerprofiles/DomainMatchingAutoMergingConflictResolution:DomainMatchingAutoMergingConflictResolution": { "properties": { "conflictResolvingModel": { "type": "string", "description": "How the auto-merging process should resolve conflicts between different profiles. Valid values are `RECENCY` and `SOURCE`\n" }, "sourceName": { "type": "string", "description": "The `ObjectType` name that is used to resolve profile merging conflicts when choosing `SOURCE` as the `ConflictResolvingModel`.\n" } }, "type": "object", "required": [ "conflictResolvingModel" ] }, "aws:customerprofiles/DomainMatchingAutoMergingConsolidation:DomainMatchingAutoMergingConsolidation": { "properties": { "matchingAttributesLists": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "description": "A list of matching criteria.\n" } }, "type": "object", "required": [ "matchingAttributesLists" ] }, "aws:customerprofiles/DomainMatchingExportingConfig:DomainMatchingExportingConfig": { "properties": { "s3Exporting": { "$ref": "#/types/aws:customerprofiles/DomainMatchingExportingConfigS3Exporting:DomainMatchingExportingConfigS3Exporting" } }, "type": "object" }, "aws:customerprofiles/DomainMatchingExportingConfigS3Exporting:DomainMatchingExportingConfigS3Exporting": { "properties": { "s3BucketName": { "type": "string", "description": "The name of the S3 bucket where Identity Resolution Jobs write result files.\n" }, "s3KeyName": { "type": "string", "description": "The S3 key name of the location where Identity Resolution Jobs write result files.\n" } }, "type": "object", "required": [ "s3BucketName" ] }, "aws:customerprofiles/DomainMatchingJobSchedule:DomainMatchingJobSchedule": { "properties": { "dayOfTheWeek": { "type": "string", "description": "The day when the Identity Resolution Job should run every week.\n" }, "time": { "type": "string", "description": "The time when the Identity Resolution Job should run every week.\n" } }, "type": "object", "required": [ "dayOfTheWeek", "time" ] }, "aws:customerprofiles/DomainRuleBasedMatching:DomainRuleBasedMatching": { "properties": { "attributeTypesSelector": { "$ref": "#/types/aws:customerprofiles/DomainRuleBasedMatchingAttributeTypesSelector:DomainRuleBasedMatchingAttributeTypesSelector", "description": "A block that configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles. Documented below.\n" }, "conflictResolution": { "$ref": "#/types/aws:customerprofiles/DomainRuleBasedMatchingConflictResolution:DomainRuleBasedMatchingConflictResolution", "description": "A block that specifies how the auto-merging process should resolve conflicts between different profiles. Documented below.\n" }, "enabled": { "type": "boolean", "description": "The flag that enables the rule-based matching process of duplicate profiles.\n" }, "exportingConfig": { "$ref": "#/types/aws:customerprofiles/DomainRuleBasedMatchingExportingConfig:DomainRuleBasedMatchingExportingConfig", "description": "A block that specifies the configuration for exporting Identity Resolution results. Documented below.\n" }, "matchingRules": { "type": "array", "items": { "$ref": "#/types/aws:customerprofiles/DomainRuleBasedMatchingMatchingRule:DomainRuleBasedMatchingMatchingRule" }, "description": "A block that configures how the rule-based matching process should match profiles. You can have up to 15 `rule` in the `natching_rules`. Documented below.\n" }, "maxAllowedRuleLevelForMatching": { "type": "integer", "description": "Indicates the maximum allowed rule level for matching.\n" }, "maxAllowedRuleLevelForMerging": { "type": "integer", "description": "Indicates the maximum allowed rule level for merging.\n" }, "status": { "type": "string" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "enabled", "status" ] } } }, "aws:customerprofiles/DomainRuleBasedMatchingAttributeTypesSelector:DomainRuleBasedMatchingAttributeTypesSelector": { "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "The `Address` type. You can choose from `Address`, `BusinessAddress`, `MaillingAddress`, and `ShippingAddress`.\n" }, "attributeMatchingModel": { "type": "string", "description": "Configures the `AttributeMatchingModel`, you can either choose `ONE_TO_ONE` or `MANY_TO_MANY`.\n" }, "emailAddresses": { "type": "array", "items": { "type": "string" }, "description": "The `Email` type. You can choose from `EmailAddress`, `BusinessEmailAddress` and `PersonalEmailAddress`.\n" }, "phoneNumbers": { "type": "array", "items": { "type": "string" }, "description": "The `PhoneNumber` type. You can choose from `PhoneNumber`, `HomePhoneNumber`, and `MobilePhoneNumber`.\n" } }, "type": "object", "required": [ "attributeMatchingModel" ] }, "aws:customerprofiles/DomainRuleBasedMatchingConflictResolution:DomainRuleBasedMatchingConflictResolution": { "properties": { "conflictResolvingModel": { "type": "string", "description": "How the auto-merging process should resolve conflicts between different profiles. Valid values are `RECENCY` and `SOURCE`\n" }, "sourceName": { "type": "string", "description": "The `ObjectType` name that is used to resolve profile merging conflicts when choosing `SOURCE` as the `ConflictResolvingModel`.\n" } }, "type": "object", "required": [ "conflictResolvingModel" ] }, "aws:customerprofiles/DomainRuleBasedMatchingExportingConfig:DomainRuleBasedMatchingExportingConfig": { "properties": { "s3Exporting": { "$ref": "#/types/aws:customerprofiles/DomainRuleBasedMatchingExportingConfigS3Exporting:DomainRuleBasedMatchingExportingConfigS3Exporting" } }, "type": "object" }, "aws:customerprofiles/DomainRuleBasedMatchingExportingConfigS3Exporting:DomainRuleBasedMatchingExportingConfigS3Exporting": { "properties": { "s3BucketName": { "type": "string", "description": "The name of the S3 bucket where Identity Resolution Jobs write result files.\n" }, "s3KeyName": { "type": "string", "description": "The S3 key name of the location where Identity Resolution Jobs write result files.\n" } }, "type": "object", "required": [ "s3BucketName" ] }, "aws:customerprofiles/DomainRuleBasedMatchingMatchingRule:DomainRuleBasedMatchingMatchingRule": { "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "A single rule level of the `match_rules`. Configures how the rule-based matching process should match profiles.\n" } }, "type": "object", "required": [ "rules" ] }, "aws:customerprofiles/ProfileAddress:ProfileAddress": { "properties": { "address1": { "type": "string", "description": "The first line of a customer address.\n" }, "address2": { "type": "string", "description": "The second line of a customer address.\n" }, "address3": { "type": "string", "description": "The third line of a customer address.\n" }, "address4": { "type": "string", "description": "The fourth line of a customer address.\n" }, "city": { "type": "string", "description": "The city in which a customer lives.\n" }, "country": { "type": "string", "description": "The country in which a customer lives.\n" }, "county": { "type": "string", "description": "The county in which a customer lives.\n" }, "postalCode": { "type": "string", "description": "The postal code of a customer address.\n" }, "province": { "type": "string", "description": "The province in which a customer lives.\n" }, "state": { "type": "string", "description": "The state in which a customer lives.\n" } }, "type": "object" }, "aws:customerprofiles/ProfileBillingAddress:ProfileBillingAddress": { "properties": { "address1": { "type": "string", "description": "The first line of a customer address.\n" }, "address2": { "type": "string", "description": "The second line of a customer address.\n" }, "address3": { "type": "string", "description": "The third line of a customer address.\n" }, "address4": { "type": "string", "description": "The fourth line of a customer address.\n" }, "city": { "type": "string", "description": "The city in which a customer lives.\n" }, "country": { "type": "string", "description": "The country in which a customer lives.\n" }, "county": { "type": "string", "description": "The county in which a customer lives.\n" }, "postalCode": { "type": "string", "description": "The postal code of a customer address.\n" }, "province": { "type": "string", "description": "The province in which a customer lives.\n" }, "state": { "type": "string", "description": "The state in which a customer lives.\n" } }, "type": "object" }, "aws:customerprofiles/ProfileMailingAddress:ProfileMailingAddress": { "properties": { "address1": { "type": "string", "description": "The first line of a customer address.\n" }, "address2": { "type": "string", "description": "The second line of a customer address.\n" }, "address3": { "type": "string", "description": "The third line of a customer address.\n" }, "address4": { "type": "string", "description": "The fourth line of a customer address.\n" }, "city": { "type": "string", "description": "The city in which a customer lives.\n" }, "country": { "type": "string", "description": "The country in which a customer lives.\n" }, "county": { "type": "string", "description": "The county in which a customer lives.\n" }, "postalCode": { "type": "string", "description": "The postal code of a customer address.\n" }, "province": { "type": "string", "description": "The province in which a customer lives.\n" }, "state": { "type": "string", "description": "The state in which a customer lives.\n" } }, "type": "object" }, "aws:customerprofiles/ProfileShippingAddress:ProfileShippingAddress": { "properties": { "address1": { "type": "string", "description": "The first line of a customer address.\n" }, "address2": { "type": "string", "description": "The second line of a customer address.\n" }, "address3": { "type": "string", "description": "The third line of a customer address.\n" }, "address4": { "type": "string", "description": "The fourth line of a customer address.\n" }, "city": { "type": "string", "description": "The city in which a customer lives.\n" }, "country": { "type": "string", "description": "The country in which a customer lives.\n" }, "county": { "type": "string", "description": "The county in which a customer lives.\n" }, "postalCode": { "type": "string", "description": "The postal code of a customer address.\n" }, "province": { "type": "string", "description": "The province in which a customer lives.\n" }, "state": { "type": "string", "description": "The state in which a customer lives.\n" } }, "type": "object" }, "aws:dataexchange/EventActionAction:EventActionAction": { "properties": { "exportRevisionToS3": { "$ref": "#/types/aws:dataexchange/EventActionActionExportRevisionToS3:EventActionActionExportRevisionToS3", "description": "Configuration for an Export Revision to S3 action.\nDescribed in `export_revision_to_s3` Configuration Block\n" } }, "type": "object" }, "aws:dataexchange/EventActionActionExportRevisionToS3:EventActionActionExportRevisionToS3": { "properties": { "encryption": { "$ref": "#/types/aws:dataexchange/EventActionActionExportRevisionToS3Encryption:EventActionActionExportRevisionToS3Encryption", "description": "Configures server-side encryption of the exported revision.\nDescribed in `encryption` Configuration Block below.\n" }, "revisionDestination": { "$ref": "#/types/aws:dataexchange/EventActionActionExportRevisionToS3RevisionDestination:EventActionActionExportRevisionToS3RevisionDestination", "description": "Configures the S3 destination of the exported revision.\nDescribed in `revision_destination` Configuration Block below.\n" } }, "type": "object" }, "aws:dataexchange/EventActionActionExportRevisionToS3Encryption:EventActionActionExportRevisionToS3Encryption": { "properties": { "kmsKeyArn": { "type": "string", "description": "ARN of the KMS key used for encryption.\n" }, "type": { "type": "string", "description": "Type of server-side encryption.\nValid values are `aws:kms` or `aws:s3`.\n" } }, "type": "object" }, "aws:dataexchange/EventActionActionExportRevisionToS3RevisionDestination:EventActionActionExportRevisionToS3RevisionDestination": { "properties": { "bucket": { "type": "string", "description": "The S3 bucket where the revision will be exported.\n" }, "keyPattern": { "type": "string", "description": "Pattern for naming revisions in the S3 bucket.\nDefaults to `${Revision.CreatedAt}/${Asset.Name}`.\n" } }, "type": "object", "required": [ "bucket" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "keyPattern" ] } } }, "aws:dataexchange/EventActionEvent:EventActionEvent": { "properties": { "revisionPublished": { "$ref": "#/types/aws:dataexchange/EventActionEventRevisionPublished:EventActionEventRevisionPublished", "description": "Configuration for a Revision Published event.\nDescribed in `revision_published` Configuration Block below.\n" } }, "type": "object" }, "aws:dataexchange/EventActionEventRevisionPublished:EventActionEventRevisionPublished": { "properties": { "dataSetId": { "type": "string", "description": "The ID of the data set to monitor for revision publications.\nChanging this value will recreate the resource.\n" } }, "type": "object", "required": [ "dataSetId" ] }, "aws:datapipeline/PipelineDefinitionParameterObject:PipelineDefinitionParameterObject": { "properties": { "attributes": { "type": "array", "items": { "$ref": "#/types/aws:datapipeline/PipelineDefinitionParameterObjectAttribute:PipelineDefinitionParameterObjectAttribute" }, "description": "Configuration block for attributes of the parameter object. See below\n" }, "id": { "type": "string", "description": "ID of the parameter object.\n" } }, "type": "object", "required": [ "id" ] }, "aws:datapipeline/PipelineDefinitionParameterObjectAttribute:PipelineDefinitionParameterObjectAttribute": { "properties": { "key": { "type": "string", "description": "Field identifier.\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "key", "stringValue" ] }, "aws:datapipeline/PipelineDefinitionParameterValue:PipelineDefinitionParameterValue": { "properties": { "id": { "type": "string", "description": "ID of the parameter value.\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "id", "stringValue" ] }, "aws:datapipeline/PipelineDefinitionPipelineObject:PipelineDefinitionPipelineObject": { "properties": { "fields": { "type": "array", "items": { "$ref": "#/types/aws:datapipeline/PipelineDefinitionPipelineObjectField:PipelineDefinitionPipelineObjectField" }, "description": "Configuration block for Key-value pairs that define the properties of the object. See below\n" }, "id": { "type": "string", "description": "ID of the object.\n" }, "name": { "type": "string", "description": "ARN of the storage connector.\n" } }, "type": "object", "required": [ "id", "name" ] }, "aws:datapipeline/PipelineDefinitionPipelineObjectField:PipelineDefinitionPipelineObjectField": { "properties": { "key": { "type": "string", "description": "Field identifier.\n" }, "refValue": { "type": "string", "description": "Field value, expressed as the identifier of another object\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "key" ] }, "aws:datapipeline/getPipelineDefinitionParameterObject:getPipelineDefinitionParameterObject": { "properties": { "attributes": { "type": "array", "items": { "$ref": "#/types/aws:datapipeline/getPipelineDefinitionParameterObjectAttribute:getPipelineDefinitionParameterObjectAttribute" } }, "id": { "type": "string", "description": "ID of the object.\n" } }, "type": "object", "required": [ "attributes", "id" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:datapipeline/getPipelineDefinitionParameterObjectAttribute:getPipelineDefinitionParameterObjectAttribute": { "properties": { "key": { "type": "string", "description": "Field identifier.\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "key", "stringValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:datapipeline/getPipelineDefinitionParameterValue:getPipelineDefinitionParameterValue": { "properties": { "id": { "type": "string", "description": "ID of the object.\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "id", "stringValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:datapipeline/getPipelineDefinitionPipelineObject:getPipelineDefinitionPipelineObject": { "properties": { "fields": { "type": "array", "items": { "$ref": "#/types/aws:datapipeline/getPipelineDefinitionPipelineObjectField:getPipelineDefinitionPipelineObjectField" }, "description": "Key-value pairs that define the properties of the object. See below\n" }, "id": { "type": "string", "description": "ID of the object.\n" }, "name": { "type": "string", "description": "ARN of the storage connector.\n" } }, "type": "object", "required": [ "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:datapipeline/getPipelineDefinitionPipelineObjectField:getPipelineDefinitionPipelineObjectField": { "properties": { "key": { "type": "string", "description": "Field identifier.\n" }, "refValue": { "type": "string", "description": "Field value, expressed as the identifier of another object\n" }, "stringValue": { "type": "string", "description": "Field value, expressed as a String.\n" } }, "type": "object", "required": [ "key", "refValue", "stringValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:datasync/EfsLocationEc2Config:EfsLocationEc2Config": { "properties": { "securityGroupArns": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.\n", "willReplaceOnChanges": true }, "subnetArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "securityGroupArns", "subnetArn" ] }, "aws:datasync/FsxOpenZfsFileSystemProtocol:FsxOpenZfsFileSystemProtocol": { "properties": { "nfs": { "$ref": "#/types/aws:datasync/FsxOpenZfsFileSystemProtocolNfs:FsxOpenZfsFileSystemProtocolNfs", "description": "Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system. See below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "nfs" ] }, "aws:datasync/FsxOpenZfsFileSystemProtocolNfs:FsxOpenZfsFileSystemProtocolNfs": { "properties": { "mountOptions": { "$ref": "#/types/aws:datasync/FsxOpenZfsFileSystemProtocolNfsMountOptions:FsxOpenZfsFileSystemProtocolNfsMountOptions", "description": "Represents the mount options that are available for DataSync to access an NFS location. See below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "mountOptions" ] }, "aws:datasync/FsxOpenZfsFileSystemProtocolNfsMountOptions:FsxOpenZfsFileSystemProtocolNfsMountOptions": { "properties": { "version": { "type": "string", "description": "The specific NFS version that you want DataSync to use for mounting your NFS share. Valid values: `AUTOMATIC`, `NFS3`, `NFS4_0` and `NFS4_1`. Default: `AUTOMATIC`\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:datasync/LocationAzureBlobSasConfiguration:LocationAzureBlobSasConfiguration": { "properties": { "token": { "type": "string", "description": "A SAS token that provides permissions to access your Azure Blob Storage.\n" } }, "type": "object", "required": [ "token" ] }, "aws:datasync/LocationFsxOntapFileSystemProtocol:LocationFsxOntapFileSystemProtocol": { "properties": { "nfs": { "$ref": "#/types/aws:datasync/LocationFsxOntapFileSystemProtocolNfs:LocationFsxOntapFileSystemProtocolNfs", "description": "Network File System (NFS) protocol that DataSync uses to access your FSx ONTAP file system. See NFS below.\n", "willReplaceOnChanges": true }, "smb": { "$ref": "#/types/aws:datasync/LocationFsxOntapFileSystemProtocolSmb:LocationFsxOntapFileSystemProtocolSmb", "description": "Server Message Block (SMB) protocol that DataSync uses to access your FSx ONTAP file system. See [SMB] (#smb) below.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:datasync/LocationFsxOntapFileSystemProtocolNfs:LocationFsxOntapFileSystemProtocolNfs": { "properties": { "mountOptions": { "$ref": "#/types/aws:datasync/LocationFsxOntapFileSystemProtocolNfsMountOptions:LocationFsxOntapFileSystemProtocolNfsMountOptions", "description": "Mount options that are available for DataSync to access an NFS location. See NFS Mount Options below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "mountOptions" ] }, "aws:datasync/LocationFsxOntapFileSystemProtocolNfsMountOptions:LocationFsxOntapFileSystemProtocolNfsMountOptions": { "properties": { "version": { "type": "string", "willReplaceOnChanges": true } }, "type": "object" }, "aws:datasync/LocationFsxOntapFileSystemProtocolSmb:LocationFsxOntapFileSystemProtocolSmb": { "properties": { "domain": { "type": "string", "description": "Fully qualified domain name of the Microsoft Active Directory (AD) that your storage virtual machine belongs to.\n", "willReplaceOnChanges": true }, "mountOptions": { "$ref": "#/types/aws:datasync/LocationFsxOntapFileSystemProtocolSmbMountOptions:LocationFsxOntapFileSystemProtocolSmbMountOptions", "description": "Mount options that are available for DataSync to access an SMB location. See SMB Mount Options below.\n", "willReplaceOnChanges": true }, "password": { "type": "string", "description": "Password of a user who has permission to access your SVM.\n", "secret": true, "willReplaceOnChanges": true }, "user": { "type": "string", "description": "Username that can mount the location and access the files, folders, and metadata that you need in the SVM.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "mountOptions", "password", "user" ] }, "aws:datasync/LocationFsxOntapFileSystemProtocolSmbMountOptions:LocationFsxOntapFileSystemProtocolSmbMountOptions": { "properties": { "version": { "type": "string", "willReplaceOnChanges": true } }, "type": "object" }, "aws:datasync/LocationHdfsNameNode:LocationHdfsNameNode": { "properties": { "hostname": { "type": "string", "description": "The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.\n" }, "port": { "type": "integer", "description": "The port that the NameNode uses to listen to client requests.\n" } }, "type": "object", "required": [ "hostname", "port" ] }, "aws:datasync/LocationHdfsQopConfiguration:LocationHdfsQopConfiguration": { "properties": { "dataTransferProtection": { "type": "string", "description": "The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster. Valid values are `DISABLED`, `AUTHENTICATION`, `INTEGRITY` and `PRIVACY`.\n" }, "rpcProtection": { "type": "string", "description": "The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster. Valid values are `DISABLED`, `AUTHENTICATION`, `INTEGRITY` and `PRIVACY`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dataTransferProtection", "rpcProtection" ] } } }, "aws:datasync/LocationSmbMountOptions:LocationSmbMountOptions": { "properties": { "version": { "type": "string", "description": "The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values: `AUTOMATIC`, `SMB2`, and `SMB3`. Default: `AUTOMATIC`\n" } }, "type": "object" }, "aws:datasync/NfsLocationMountOptions:NfsLocationMountOptions": { "properties": { "version": { "type": "string", "description": "The specific NFS version that you want DataSync to use for mounting your NFS share. Valid values: `AUTOMATIC`, `NFS3`, `NFS4_0` and `NFS4_1`. Default: `AUTOMATIC`\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:datasync/NfsLocationOnPremConfig:NfsLocationOnPremConfig": { "properties": { "agentArns": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon Resource Names (ARNs) of the DataSync Agents used to connect to the NFS server.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "agentArns" ] }, "aws:datasync/S3LocationS3Config:S3LocationS3Config": { "properties": { "bucketAccessRoleArn": { "type": "string", "description": "ARN of the IAM Role used to connect to the S3 Bucket.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucketAccessRoleArn" ] }, "aws:datasync/TaskExcludes:TaskExcludes": { "properties": { "filterType": { "type": "string", "description": "The type of filter rule to apply. Valid values: `SIMPLE_PATTERN`.\n" }, "value": { "type": "string", "description": "A single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: `/folder1|/folder2`\n" } }, "type": "object" }, "aws:datasync/TaskIncludes:TaskIncludes": { "properties": { "filterType": { "type": "string", "description": "The type of filter rule to apply. Valid values: `SIMPLE_PATTERN`.\n" }, "value": { "type": "string", "description": "A single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: `/folder1|/folder2`\n" } }, "type": "object" }, "aws:datasync/TaskOptions:TaskOptions": { "properties": { "atime": { "type": "string", "description": "A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to `BEST_EFFORT`, the DataSync Task attempts to preserve the original (that is, the version before sync `PREPARING` phase) `atime` attribute on all source files. Valid values: `BEST_EFFORT`, `NONE`. Default: `BEST_EFFORT`.\n" }, "bytesPerSecond": { "type": "integer", "description": "Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to `1048576`. Value values: `-1` or greater. Default: `-1` (unlimited).\n" }, "gid": { "type": "string", "description": "Group identifier of the file's owners. Valid values: `BOTH`, `INT_VALUE`, `NAME`, `NONE`. Default: `INT_VALUE` (preserve integer value of the ID).\n" }, "logLevel": { "type": "string", "description": "Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: `OFF`, `BASIC`, `TRANSFER`. Default: `OFF`.\n" }, "mtime": { "type": "string", "description": "A file metadata that indicates the last time a file was modified (written to) before the sync `PREPARING` phase. Value values: `NONE`, `PRESERVE`. Default: `PRESERVE`.\n" }, "objectTags": { "type": "string", "description": "Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: `PRESERVE`, `NONE`. Default value: `PRESERVE`.\n" }, "overwriteMode": { "type": "string", "description": "Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: `ALWAYS`, `NEVER`. Default: `ALWAYS`.\n" }, "posixPermissions": { "type": "string", "description": "Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: `NONE`, `PRESERVE`. Default: `PRESERVE`.\n" }, "preserveDeletedFiles": { "type": "string", "description": "Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: `PRESERVE`, `REMOVE`. Default: `PRESERVE`.\n" }, "preserveDevices": { "type": "string", "description": "Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: `NONE`, `PRESERVE`. Default: `NONE` (ignore special devices).\n" }, "securityDescriptorCopyFlags": { "type": "string", "description": "Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: `NONE`, `OWNER_DACL`, `OWNER_DACL_SACL`. Default: `OWNER_DACL`.\n" }, "taskQueueing": { "type": "string", "description": "Determines whether tasks should be queued before executing the tasks. Valid values: `ENABLED`, `DISABLED`. Default `ENABLED`.\n" }, "transferMode": { "type": "string", "description": "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. Valid values: `CHANGED`, `ALL`. Default: `CHANGED`\n" }, "uid": { "type": "string", "description": "User identifier of the file's owners. Valid values: `BOTH`, `INT_VALUE`, `NAME`, `NONE`. Default: `INT_VALUE` (preserve integer value of the ID).\n" }, "verifyMode": { "type": "string", "description": "Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: `NONE`, `POINT_IN_TIME_CONSISTENT`, `ONLY_FILES_TRANSFERRED`. Default: `POINT_IN_TIME_CONSISTENT`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityDescriptorCopyFlags" ] } } }, "aws:datasync/TaskSchedule:TaskSchedule": { "properties": { "scheduleExpression": { "type": "string", "description": "Specifies the schedule you want your task to use for repeated executions. For more information, see [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html).\n" } }, "type": "object", "required": [ "scheduleExpression" ] }, "aws:datasync/TaskTaskReportConfig:TaskTaskReportConfig": { "properties": { "outputType": { "type": "string", "description": "Specifies the type of task report you'd like. Valid values: `SUMMARY_ONLY` and `STANDARD`.\n" }, "reportLevel": { "type": "string", "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. Valid values: `ERRORS_ONLY` and `SUCCESSES_AND_ERRORS`.\n" }, "reportOverrides": { "$ref": "#/types/aws:datasync/TaskTaskReportConfigReportOverrides:TaskTaskReportConfigReportOverrides", "description": "Configuration block containing the configuration of the reporting level for aspects of your task report. See `report_overrides` below.\n" }, "s3Destination": { "$ref": "#/types/aws:datasync/TaskTaskReportConfigS3Destination:TaskTaskReportConfigS3Destination", "description": "Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See `s3_destination` below.\n" }, "s3ObjectVersioning": { "type": "string", "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. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: `INCLUDE` and `NONE`.\n" } }, "type": "object", "required": [ "s3Destination" ] }, "aws:datasync/TaskTaskReportConfigReportOverrides:TaskTaskReportConfigReportOverrides": { "properties": { "deletedOverride": { "type": "string", "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. Valid values: `ERRORS_ONLY` and `SUCCESSES_AND_ERRORS`.\n" }, "skippedOverride": { "type": "string", "description": "Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: `ERRORS_ONLY` and `SUCCESSES_AND_ERRORS`.\n" }, "transferredOverride": { "type": "string", "description": "Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: `ERRORS_ONLY` and `SUCCESSES_AND_ERRORS`.\n" }, "verifiedOverride": { "type": "string", "description": "Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: `ERRORS_ONLY` and `SUCCESSES_AND_ERRORS`.\n\n\u003e **NOTE:** If any `report_overrides` are set to the same value as `task_report_config.report_level`, they will always be flagged as changed. Only set overrides to a value that differs from `task_report_config.report_level`.\n" } }, "type": "object" }, "aws:datasync/TaskTaskReportConfigS3Destination:TaskTaskReportConfigS3Destination": { "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.\n" }, "s3BucketArn": { "type": "string", "description": "Specifies the ARN of the S3 bucket where DataSync uploads your report.\n" }, "subdirectory": { "type": "string", "description": "Specifies a bucket prefix for your report.\n" } }, "type": "object", "required": [ "bucketAccessRoleArn", "s3BucketArn" ] }, "aws:datazone/AssetTypeFormsInput:AssetTypeFormsInput": { "properties": { "mapBlockKey": { "type": "string" }, "required": { "type": "boolean" }, "typeIdentifier": { "type": "string" }, "typeRevision": { "type": "string" } }, "type": "object", "required": [ "mapBlockKey", "typeIdentifier", "typeRevision" ] }, "aws:datazone/AssetTypeTimeouts:AssetTypeTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:datazone/DomainSingleSignOn:DomainSingleSignOn": { "properties": { "type": { "type": "string" }, "userAssignment": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:datazone/DomainTimeouts:DomainTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:datazone/EnvironmentLastDeployment:EnvironmentLastDeployment": { "properties": { "deploymentId": { "type": "string" }, "deploymentStatus": { "type": "string" }, "deploymentType": { "type": "string" }, "failureReasons": { "type": "array", "items": { "$ref": "#/types/aws:datazone/EnvironmentLastDeploymentFailureReason:EnvironmentLastDeploymentFailureReason" } }, "isDeploymentComplete": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "deploymentId", "deploymentStatus", "deploymentType", "failureReasons", "isDeploymentComplete", "messages" ] }, "aws:datazone/EnvironmentLastDeploymentFailureReason:EnvironmentLastDeploymentFailureReason": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ] }, "aws:datazone/EnvironmentProfileUserParameter:EnvironmentProfileUserParameter": { "properties": { "name": { "type": "string", "description": "Name of the environment profile parameter.\n" }, "value": { "type": "string", "description": "Value of the environment profile parameter.\n" } }, "type": "object" }, "aws:datazone/EnvironmentProvisionedResource:EnvironmentProvisionedResource": { "properties": { "name": { "type": "string", "description": "The name of the environment.\n" }, "provider": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string", "description": "The value of an environment profile parameter.\n" } }, "type": "object", "required": [ "name", "provider", "type", "value" ] }, "aws:datazone/EnvironmentTimeouts:EnvironmentTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:datazone/EnvironmentUserParameter:EnvironmentUserParameter": { "properties": { "name": { "type": "string", "description": "The name of an environment profile parameter.\n" }, "value": { "type": "string", "description": "The value of an environment profile parameter.\n" } }, "type": "object" }, "aws:datazone/FormTypeImport:FormTypeImport": { "properties": { "name": { "type": "string", "description": "Name of the form type. Must be the name of the structure in smithy document.\n" }, "revision": { "type": "string", "description": "Revision of the Form Type.\n" } }, "type": "object", "required": [ "name", "revision" ] }, "aws:datazone/FormTypeModel:FormTypeModel": { "properties": { "smithy": { "type": "string", "description": "Smithy document that indicates the model of the API. Must be between the lengths 1 and 100,000 and be encoded as a smithy document.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "smithy" ] }, "aws:datazone/FormTypeTimeouts:FormTypeTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:datazone/GlossaryTermTermRelations:GlossaryTermTermRelations": { "properties": { "classifies": { "type": "array", "items": { "type": "string" }, "description": "String array that calssifies the term relations.\n" }, "isAs": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:datazone/GlossaryTermTimeouts:GlossaryTermTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:datazone/ProjectFailureReason:ProjectFailureReason": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ] }, "aws:datazone/ProjectTimeouts:ProjectTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:datazone/UserProfileDetail:UserProfileDetail": { "properties": { "iams": { "type": "array", "items": { "$ref": "#/types/aws:datazone/UserProfileDetailIam:UserProfileDetailIam" } }, "ssos": { "type": "array", "items": { "$ref": "#/types/aws:datazone/UserProfileDetailSso:UserProfileDetailSso" } } }, "type": "object", "required": [ "iams", "ssos" ] }, "aws:datazone/UserProfileDetailIam:UserProfileDetailIam": { "properties": { "arn": { "type": "string" } }, "type": "object", "required": [ "arn" ] }, "aws:datazone/UserProfileDetailSso:UserProfileDetailSso": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" } }, "type": "object", "required": [ "firstName", "lastName", "userName" ] }, "aws:datazone/UserProfileTimeouts:UserProfileTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:dax/ClusterNode:ClusterNode": { "properties": { "address": { "type": "string" }, "availabilityZone": { "type": "string" }, "id": { "type": "string" }, "port": { "type": "integer", "description": "The port used by the configuration endpoint\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "availabilityZone", "id", "port" ] } } }, "aws:dax/ClusterServerSideEncryption:ClusterServerSideEncryption": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable encryption at rest. Defaults to `false`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:dax/ParameterGroupParameter:ParameterGroupParameter": { "properties": { "name": { "type": "string", "description": "The name of the parameter.\n" }, "value": { "type": "string", "description": "The value for the parameter.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:devicefarm/DevicePoolRule:DevicePoolRule": { "properties": { "attribute": { "type": "string", "description": "The rule's stringified attribute. Valid values are: `APPIUM_VERSION`, `ARN`, `AVAILABILITY`, `FLEET_TYPE`, `FORM_FACTOR`, `INSTANCE_ARN`, `INSTANCE_LABELS`, `MANUFACTURER`, `MODEL`, `OS_VERSION`, `PLATFORM`, `REMOTE_ACCESS_ENABLED`, `REMOTE_DEBUG_ENABLED`.\n" }, "operator": { "type": "string", "description": "Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute. Valid values are: `EQUALS`, `NOT_IN`, `IN`, `GREATER_THAN`, `GREATER_THAN_OR_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUALS`, `CONTAINS`.\n" }, "value": { "type": "string", "description": "The rule's value.\n" } }, "type": "object" }, "aws:devicefarm/TestGridProjectVpcConfig:TestGridProjectVpcConfig": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of VPC security group IDs in your Amazon VPC.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of VPC subnet IDs in your Amazon VPC.\n" }, "vpcId": { "type": "string", "description": "The ID of the Amazon VPC.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds", "vpcId" ] }, "aws:devopsguru/EventSourcesConfigEventSource:EventSourcesConfigEventSource": { "properties": { "amazonCodeGuruProfilers": { "type": "array", "items": { "$ref": "#/types/aws:devopsguru/EventSourcesConfigEventSourceAmazonCodeGuruProfiler:EventSourcesConfigEventSourceAmazonCodeGuruProfiler" }, "description": "Stores whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler. See `amazon_code_guru_profiler` below.\n" } }, "type": "object" }, "aws:devopsguru/EventSourcesConfigEventSourceAmazonCodeGuruProfiler:EventSourcesConfigEventSourceAmazonCodeGuruProfiler": { "properties": { "status": { "type": "string", "description": "Status of the CodeGuru Profiler integration. Valid values are `ENABLED` and `DISABLED`.\n" } }, "type": "object", "required": [ "status" ] }, "aws:devopsguru/NotificationChannelFilters:NotificationChannelFilters": { "properties": { "messageTypes": { "type": "array", "items": { "type": "string" }, "description": "Events to receive notifications for. Valid values are `NEW_INSIGHT`, `CLOSED_INSIGHT`, `NEW_ASSOCIATION`, `SEVERITY_UPGRADED`, and `NEW_RECOMMENDATION`.\n" }, "severities": { "type": "array", "items": { "type": "string" }, "description": "Severity levels to receive notifications for. Valid values are `LOW`, `MEDIUM`, and `HIGH`.\n" } }, "type": "object" }, "aws:devopsguru/NotificationChannelSns:NotificationChannelSns": { "properties": { "topicArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.\n" } }, "type": "object", "required": [ "topicArn" ] }, "aws:devopsguru/ResourceCollectionCloudformation:ResourceCollectionCloudformation": { "properties": { "stackNames": { "type": "array", "items": { "type": "string" }, "description": "Array of the names of the AWS CloudFormation stacks. If `type` is `AWS_SERVICE` (all acccount resources) this array should be a single item containing a wildcard (`\"*\"`).\n" } }, "type": "object", "required": [ "stackNames" ] }, "aws:devopsguru/ResourceCollectionTags:ResourceCollectionTags": { "properties": { "appBoundaryKey": { "type": "string", "description": "An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes. All AWS resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary. The key must begin with the prefix `DevOps-Guru-`. Any casing can be used for the prefix, but the associated tags __must use the same casing__ in their tag key.\n" }, "tagValues": { "type": "array", "items": { "type": "string" }, "description": "Array of tag values. These can be used to further filter for specific resources within the application boundary. To analyze all resources tagged with the `app_boundary_key` regardless of the corresponding tag value, this array should be a single item containing a wildcard (`\"*\"`).\n" } }, "type": "object", "required": [ "appBoundaryKey", "tagValues" ] }, "aws:devopsguru/ServiceIntegrationKmsServerSideEncryption:ServiceIntegrationKmsServerSideEncryption": { "properties": { "kmsKeyId": { "type": "string", "description": "KMS key ID. This value can be a key ID, key ARN, alias name, or alias ARN.\n" }, "optInStatus": { "type": "string", "description": "Specifies whether KMS integration is enabled. Valid values are `DISABLED` and `ENABLED`.\n" }, "type": { "type": "string", "description": "Type of KMS key used. Valid values are `CUSTOMER_MANAGED_KEY` and `AWS_OWNED_KMS_KEY`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kmsKeyId", "optInStatus", "type" ] } } }, "aws:devopsguru/ServiceIntegrationLogsAnomalyDetection:ServiceIntegrationLogsAnomalyDetection": { "properties": { "optInStatus": { "type": "string", "description": "Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups. Valid values are `DISABLED` and `ENABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "optInStatus" ] } } }, "aws:devopsguru/ServiceIntegrationOpsCenter:ServiceIntegrationOpsCenter": { "properties": { "optInStatus": { "type": "string", "description": "Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight. Valid values are `DISABLED` and `ENABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "optInStatus" ] } } }, "aws:devopsguru/getNotificationChannelFilter:getNotificationChannelFilter": { "properties": { "messageTypes": { "type": "array", "items": { "type": "string" }, "description": "Events to receive notifications for.\n" }, "severities": { "type": "array", "items": { "type": "string" }, "description": "Severity levels to receive notifications for.\n" } }, "type": "object", "required": [ "messageTypes", "severities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:devopsguru/getNotificationChannelSn:getNotificationChannelSn": { "properties": { "topicArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.\n" } }, "type": "object", "required": [ "topicArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:devopsguru/getResourceCollectionCloudformation:getResourceCollectionCloudformation": { "properties": { "stackNames": { "type": "array", "items": { "type": "string" }, "description": "Array of the names of the AWS CloudFormation stacks.\n" } }, "type": "object", "required": [ "stackNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:devopsguru/getResourceCollectionTag:getResourceCollectionTag": { "properties": { "appBoundaryKey": { "type": "string", "description": "An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes.\n" }, "tagValues": { "type": "array", "items": { "type": "string" }, "description": "Array of tag values.\n" } }, "type": "object", "required": [ "appBoundaryKey", "tagValues" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:directconnect/getRouterConfigurationRouter:getRouterConfigurationRouter": { "properties": { "platform": { "type": "string", "description": "Router platform\n" }, "routerTypeIdentifier": { "type": "string", "description": "ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124`\n\nThere is currently no AWS API to retrieve the full list of `router_type_identifier` values. Here is a list of known `RouterType` objects that can be used:\n\n```json\n{\n\"routerTypes\": [\n{\"platform\":\"2900 Series Routers\",\"routerTypeIdentifier\":\"CiscoSystemsInc-2900SeriesRouters-IOS124\",\"software\":\"IOS 12.4+\",\"vendor\":\"Cisco Systems, Inc.\",\"xsltTemplateName\":\"customer-router-cisco-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"3700 Series Routers\",\"routerTypeIdentifier\":\"CiscoSystemsInc-3700SeriesRouters-IOS124\",\"software\":\"IOS 12.4+\",\"vendor\":\"Cisco Systems, Inc.\",\"xsltTemplateName\":\"customer-router-cisco-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"7200 Series Routers\",\"routerTypeIdentifier\":\"CiscoSystemsInc-7200SeriesRouters-IOS124\",\"software\":\"IOS 12.4+\",\"vendor\":\"Cisco Systems, Inc.\",\"xsltTemplateName\":\"customer-router-cisco-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"Nexus 7000 Series Switches\",\"routerTypeIdentifier\":\"CiscoSystemsInc-Nexus7000SeriesSwitches-NXOS51\",\"software\":\"NX-OS 5.1+\",\"vendor\":\"Cisco Systems, Inc.\",\"xsltTemplateName\":\"customer-switch-cisco-nexus-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"Nexus 9K+ Series Switches\",\"routerTypeIdentifier\":\"CiscoSystemsInc-Nexus9KSeriesSwitches-NXOS93\",\"software\":\"NX-OS 9.3+\",\"vendor\":\"Cisco Systems, Inc.\",\"xsltTemplateName\":\"customer-switch-cisco-nexus-generic.xslt\",\"xsltTemplateNameForMacSec\":\"customer-switch-cisco-nexus-generic-macsec.xslt\"},\n{\"platform\":\"M/MX Series Routers\",\"routerTypeIdentifier\":\"JuniperNetworksInc-MMXSeriesRouters-JunOS95\",\"software\":\"JunOS 9.5+\",\"vendor\":\"Juniper Networks, Inc.\",\"xsltTemplateName\":\"customer-router-juniper-generic.xslt\",\"xsltTemplateNameForMacSec\":\"customer-router-juniper-generic-macsec.xslt\"},\n{\"platform\":\"SRX Series Routers\",\"routerTypeIdentifier\":\"JuniperNetworksInc-SRXSeriesRouters-JunOS95\",\"software\":\"JunOS 9.5+\",\"vendor\":\"Juniper Networks, Inc.\",\"xsltTemplateName\":\"customer-router-juniper-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"T Series Routers\",\"routerTypeIdentifier\":\"JuniperNetworksInc-TSeriesRouters-JunOS95\",\"software\":\"JunOS 9.5+\",\"vendor\":\"Juniper Networks, Inc.\",\"xsltTemplateName\":\"customer-router-juniper-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"},\n{\"platform\":\"PA-3000+ and 5000+ series\",\"routerTypeIdentifier\":\"PaloAltoNetworks-PA3000and5000series-PANOS803\",\"software\":\"PAN-OS 8.0.3+\",\"vendor\":\"Palo Alto Networks\",\"xsltTemplateName\":\"customer-router-palo-alto-generic.xslt\",\"xsltTemplateNameForMacSec\":\"\"}]\n}\n```\n" }, "software": { "type": "string", "description": "Router operating system\n" }, "vendor": { "type": "string", "description": "Router vendor\n" }, "xsltTemplateName": { "type": "string", "description": "Router XSLT Template Name\n" }, "xsltTemplateNameForMacSec": { "type": "string" } }, "type": "object", "required": [ "platform", "routerTypeIdentifier", "software", "vendor", "xsltTemplateName", "xsltTemplateNameForMacSec" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:directoryservice/DirectoryConnectSettings:DirectoryConnectSettings": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" } }, "connectIps": { "type": "array", "items": { "type": "string" }, "description": "The IP addresses of the AD Connector servers.\n" }, "customerDnsIps": { "type": "array", "items": { "type": "string" }, "description": "The DNS IP addresses of the domain to connect to.\n", "willReplaceOnChanges": true }, "customerUsername": { "type": "string", "description": "The username corresponding to the password provided.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The identifier of the VPC that the directory is in.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "customerDnsIps", "customerUsername", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityZones", "connectIps", "customerDnsIps", "customerUsername", "subnetIds", "vpcId" ] } } }, "aws:directoryservice/DirectoryVpcSettings:DirectoryVpcSettings": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" } }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The identifier of the VPC that the directory is in.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityZones", "subnetIds", "vpcId" ] } } }, "aws:directoryservice/ServiceRegionVpcSettings:ServiceRegionVpcSettings": { "properties": { "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The identifiers of the subnets for the directory servers.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The identifier of the VPC in which to create the directory.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnetIds", "vpcId" ] }, "aws:directoryservice/SharedDirectoryTarget:SharedDirectoryTarget": { "properties": { "id": { "type": "string", "description": "Identifier of the directory consumer account.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of identifier to be used in the `id` field. Valid value is `ACCOUNT`. Default is `ACCOUNT`.\n" } }, "type": "object", "required": [ "id" ] }, "aws:directoryservice/getDirectoryConnectSetting:getDirectoryConnectSetting": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" } }, "connectIps": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the AD Connector servers.\n" }, "customerDnsIps": { "type": "array", "items": { "type": "string" }, "description": "DNS IP addresses of the domain to connect to.\n" }, "customerUsername": { "type": "string", "description": "Username corresponding to the password provided.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).\n" }, "vpcId": { "type": "string", "description": "ID of the VPC that the connector is in.\n" } }, "type": "object", "required": [ "availabilityZones", "connectIps", "customerDnsIps", "customerUsername", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:directoryservice/getDirectoryRadiusSetting:getDirectoryRadiusSetting": { "properties": { "authenticationProtocol": { "type": "string", "description": "The protocol specified for your RADIUS endpoints.\n" }, "displayLabel": { "type": "string", "description": "Display label.\n" }, "radiusPort": { "type": "integer", "description": "Port that your RADIUS server is using for communications.\n" }, "radiusRetries": { "type": "integer", "description": "Maximum number of times that communication with the RADIUS server is attempted.\n" }, "radiusServers": { "type": "array", "items": { "type": "string" }, "description": "Set of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.\n" }, "radiusTimeout": { "type": "integer", "description": "Amount of time, in seconds, to wait for the RADIUS server to respond.\n" }, "useSameUsername": { "type": "boolean", "description": "Not currently used.\n" } }, "type": "object", "required": [ "authenticationProtocol", "displayLabel", "radiusPort", "radiusRetries", "radiusServers", "radiusTimeout", "useSameUsername" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:directoryservice/getDirectoryVpcSetting:getDirectoryVpcSetting": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" } }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).\n" }, "vpcId": { "type": "string", "description": "ID of the VPC that the connector is in.\n" } }, "type": "object", "required": [ "availabilityZones", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dlm/LifecyclePolicyPolicyDetails:LifecyclePolicyPolicyDetails": { "properties": { "action": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsAction:LifecyclePolicyPolicyDetailsAction", "description": "The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the `action` configuration block.\n" }, "eventSource": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsEventSource:LifecyclePolicyPolicyDetailsEventSource", "description": "The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the `event_source` configuration block.\n" }, "parameters": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsParameters:LifecyclePolicyPolicyDetailsParameters" }, "policyType": { "type": "string", "description": "The valid target resource types and actions a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY` to create an event-based policy that performs specific actions when a defined event occurs in your AWS account. Default value is `EBS_SNAPSHOT_MANAGEMENT`.\n" }, "resourceLocations": { "type": "string", "description": "The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account. Valid values are `CLOUD` and `OUTPOST`.\n" }, "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of resource types that should be targeted by the lifecycle policy. Valid values are `VOLUME` and `INSTANCE`.\n" }, "schedules": { "type": "array", "items": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsSchedule:LifecyclePolicyPolicyDetailsSchedule" }, "description": "See the `schedule` configuration block.\n" }, "targetTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tag keys and their values. Any resources that match the `resource_types` and are tagged with _any_ of these tags will be targeted.\n\n\u003e Note: You cannot have overlapping lifecycle policies that share the same `target_tags`. Pulumi is unable to detect this at plan time but it will fail during apply.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceLocations" ] } } }, "aws:dlm/LifecyclePolicyPolicyDetailsAction:LifecyclePolicyPolicyDetailsAction": { "properties": { "crossRegionCopies": { "type": "array", "items": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopy:LifecyclePolicyPolicyDetailsActionCrossRegionCopy" }, "description": "The rule for copying shared snapshots across Regions. See the `cross_region_copy` configuration block.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "crossRegionCopies", "name" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopy:LifecyclePolicyPolicyDetailsActionCrossRegionCopy": { "properties": { "encryptionConfiguration": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopyEncryptionConfiguration:LifecyclePolicyPolicyDetailsActionCrossRegionCopyEncryptionConfiguration", "description": "The encryption settings for the copied snapshot. See the `encryption_configuration` block. Max of 1 per action.\n" }, "retainRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopyRetainRule:LifecyclePolicyPolicyDetailsActionCrossRegionCopyRetainRule" }, "target": { "type": "string" } }, "type": "object", "required": [ "encryptionConfiguration", "target" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopyEncryptionConfiguration:LifecyclePolicyPolicyDetailsActionCrossRegionCopyEncryptionConfiguration": { "properties": { "cmkArn": { "type": "string" }, "encrypted": { "type": "boolean" } }, "type": "object" }, "aws:dlm/LifecyclePolicyPolicyDetailsActionCrossRegionCopyRetainRule:LifecyclePolicyPolicyDetailsActionCrossRegionCopyRetainRule": { "properties": { "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object", "required": [ "interval", "intervalUnit" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsEventSource:LifecyclePolicyPolicyDetailsEventSource": { "properties": { "parameters": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsEventSourceParameters:LifecyclePolicyPolicyDetailsEventSourceParameters" }, "type": { "type": "string", "description": "The source of the event. Currently only managed CloudWatch Events rules are supported. Valid values are `MANAGED_CWE`.\n" } }, "type": "object", "required": [ "parameters", "type" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsEventSourceParameters:LifecyclePolicyPolicyDetailsEventSourceParameters": { "properties": { "descriptionRegex": { "type": "string", "description": "The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.\n" }, "eventType": { "type": "string", "description": "The type of event. Currently, only `shareSnapshot` events are supported.\n" }, "snapshotOwners": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.\n" } }, "type": "object", "required": [ "descriptionRegex", "eventType", "snapshotOwners" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsParameters:LifecyclePolicyPolicyDetailsParameters": { "properties": { "excludeBootVolume": { "type": "boolean", "description": "Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is `false`.\n" }, "noReboot": { "type": "boolean", "description": "Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. `true` indicates that targeted instances are not rebooted when the policy runs. `false` indicates that target instances are rebooted when the policy runs. The default is `true` (instances are not rebooted).\n" } }, "type": "object" }, "aws:dlm/LifecyclePolicyPolicyDetailsSchedule:LifecyclePolicyPolicyDetailsSchedule": { "properties": { "copyTags": { "type": "boolean", "willReplaceOnChanges": true }, "createRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleCreateRule:LifecyclePolicyPolicyDetailsScheduleCreateRule", "description": "See the `create_rule` block. Max of 1 per schedule.\n" }, "crossRegionCopyRules": { "type": "array", "items": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRule" }, "description": "See the `cross_region_copy_rule` block. Max of 3 per schedule.\n" }, "deprecateRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleDeprecateRule:LifecyclePolicyPolicyDetailsScheduleDeprecateRule" }, "fastRestoreRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleFastRestoreRule:LifecyclePolicyPolicyDetailsScheduleFastRestoreRule", "description": "See the `fast_restore_rule` block. Max of 1 per schedule.\n" }, "name": { "type": "string" }, "retainRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleRetainRule:LifecyclePolicyPolicyDetailsScheduleRetainRule" }, "shareRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleShareRule:LifecyclePolicyPolicyDetailsScheduleShareRule", "description": "See the `share_rule` block. Max of 1 per schedule.\n" }, "tagsToAdd": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tag keys and their values. DLM lifecycle policies will already tag the snapshot with the tags on the volume. This configuration adds extra tags on top of these.\n" }, "variableTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tag keys and variable values, where the values are determined when the policy is executed. Only `$(instance-id)` or `$(timestamp)` are valid values. Can only be used when `resource_types` is `INSTANCE`.\n" } }, "type": "object", "required": [ "createRule", "name", "retainRule" ], "language": { "nodejs": { "requiredOutputs": [ "copyTags", "createRule", "name", "retainRule" ] } } }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleCreateRule:LifecyclePolicyPolicyDetailsScheduleCreateRule": { "properties": { "cronExpression": { "type": "string", "description": "The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. Conflicts with `interval`, `interval_unit`, and `times`.\n" }, "interval": { "type": "integer" }, "intervalUnit": { "type": "string" }, "location": { "type": "string", "description": "Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify `CLOUD`. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`. If you omit this parameter, `CLOUD` is used by default. If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost. Valid values are `CLOUD` and `OUTPOST_LOCAL`.\n" }, "times": { "type": "string", "description": "A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with `cron_expression`. Must be set if `interval` is set.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "intervalUnit", "location", "times" ] } } }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRule": { "properties": { "cmkArn": { "type": "string" }, "copyTags": { "type": "boolean" }, "deprecateRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleDeprecateRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleDeprecateRule" }, "encrypted": { "type": "boolean" }, "retainRule": { "$ref": "#/types/aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleRetainRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleRetainRule" }, "target": { "type": "string" } }, "type": "object", "required": [ "encrypted", "target" ], "language": { "nodejs": { "requiredOutputs": [ "copyTags", "encrypted", "target" ] } } }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleDeprecateRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleDeprecateRule": { "properties": { "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object", "required": [ "interval", "intervalUnit" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleRetainRule:LifecyclePolicyPolicyDetailsScheduleCrossRegionCopyRuleRetainRule": { "properties": { "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object", "required": [ "interval", "intervalUnit" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleDeprecateRule:LifecyclePolicyPolicyDetailsScheduleDeprecateRule": { "properties": { "count": { "type": "integer" }, "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object" }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleFastRestoreRule:LifecyclePolicyPolicyDetailsScheduleFastRestoreRule": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "The Availability Zones in which to enable fast snapshot restore.\n" }, "count": { "type": "integer" }, "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object", "required": [ "availabilityZones" ] }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleRetainRule:LifecyclePolicyPolicyDetailsScheduleRetainRule": { "properties": { "count": { "type": "integer" }, "interval": { "type": "integer" }, "intervalUnit": { "type": "string" } }, "type": "object" }, "aws:dlm/LifecyclePolicyPolicyDetailsScheduleShareRule:LifecyclePolicyPolicyDetailsScheduleShareRule": { "properties": { "targetAccounts": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the AWS accounts with which to share the snapshots.\n" }, "unshareInterval": { "type": "integer", "description": "The period after which snapshots that are shared with other AWS accounts are automatically unshared.\n" }, "unshareIntervalUnit": { "type": "string", "description": "The unit of time for the automatic unsharing interval. Valid values are `DAYS`, `WEEKS`, `MONTHS`, `YEARS`.\n" } }, "type": "object", "required": [ "targetAccounts" ] }, "aws:dms/EndpointElasticsearchSettings:EndpointElasticsearchSettings": { "properties": { "endpointUri": { "type": "string", "description": "Endpoint for the OpenSearch cluster.\n", "willReplaceOnChanges": true }, "errorRetryDuration": { "type": "integer", "description": "Maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. Default is `300`.\n", "willReplaceOnChanges": true }, "fullLoadErrorPercentage": { "type": "integer", "description": "Maximum percentage of records that can fail to be written before a full load operation stops. Default is `10`.\n", "willReplaceOnChanges": true }, "serviceAccessRoleArn": { "type": "string", "description": "ARN of the IAM Role with permissions to write to the OpenSearch cluster.\n", "willReplaceOnChanges": true }, "useNewMappingType": { "type": "boolean", "description": "Enable to migrate documentation using the documentation type `_doc`. OpenSearch and an Elasticsearch clusters only support the _doc documentation type in versions 7.x and later. The default value is `false`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "endpointUri", "serviceAccessRoleArn" ] }, "aws:dms/EndpointKafkaSettings:EndpointKafkaSettings": { "properties": { "broker": { "type": "string", "description": "Kafka broker location. Specify in the form broker-hostname-or-ip:port.\n" }, "includeControlDetails": { "type": "boolean", "description": "Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. Default is `false`.\n" }, "includeNullAndEmpty": { "type": "boolean", "description": "Include NULL and empty columns for records migrated to the endpoint. Default is `false`.\n" }, "includePartitionValue": { "type": "boolean", "description": "Shows the partition value within the Kafka message output unless the partition type is `schema-table-type`. Default is `false`.\n" }, "includeTableAlterOperations": { "type": "boolean", "description": "Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table`, `drop-table`, `add-column`, `drop-column`, and `rename-column`. Default is `false`.\n" }, "includeTransactionDetails": { "type": "boolean", "description": "Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for `transaction_id`, previous `transaction_id`, and `transaction_record_id` (the record offset within a transaction). Default is `false`.\n" }, "messageFormat": { "type": "string", "description": "Output format for the records created on the endpoint. Message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab).\n" }, "messageMaxBytes": { "type": "integer", "description": "Maximum size in bytes for records created on the endpoint Default is `1,000,000`.\n" }, "noHexPrefix": { "type": "boolean", "description": "Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the `no_hex_prefix` endpoint setting to enable migration of RAW data type columns without adding the `'0x'` prefix.\n" }, "partitionIncludeSchemaTable": { "type": "boolean", "description": "Prefixes schema and table names to partition values, when the partition type is `primary-key-type`. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. Default is `false`.\n" }, "saslMechanism": { "type": "string", "description": "For SASL/SSL authentication, AWS DMS supports the `scram-sha-512` mechanism by default. AWS DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to `plain`.\n" }, "saslPassword": { "type": "string", "description": "Secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.\n", "secret": true }, "saslUsername": { "type": "string", "description": "Secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.\n" }, "securityProtocol": { "type": "string", "description": "Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include `ssl-encryption`, `ssl-authentication`, and `sasl-ssl`. `sasl-ssl` requires `sasl_username` and `sasl_password`.\n" }, "sslCaCertificateArn": { "type": "string", "description": "ARN for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.\n" }, "sslClientCertificateArn": { "type": "string", "description": "ARN of the client certificate used to securely connect to a Kafka target endpoint.\n" }, "sslClientKeyArn": { "type": "string", "description": "ARN for the client private key used to securely connect to a Kafka target endpoint.\n" }, "sslClientKeyPassword": { "type": "string", "description": "Password for the client private key used to securely connect to a Kafka target endpoint.\n", "secret": true }, "topic": { "type": "string", "description": "Kafka topic for migration. Default is `kafka-default-topic`.\n" } }, "type": "object", "required": [ "broker" ] }, "aws:dms/EndpointKinesisSettings:EndpointKinesisSettings": { "properties": { "includeControlDetails": { "type": "boolean", "description": "Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. Default is `false`.\n" }, "includeNullAndEmpty": { "type": "boolean", "description": "Include NULL and empty columns in the target. Default is `false`.\n" }, "includePartitionValue": { "type": "boolean", "description": "Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. Default is `false`.\n" }, "includeTableAlterOperations": { "type": "boolean", "description": "Includes any data definition language (DDL) operations that change the table in the control data. Default is `false`.\n" }, "includeTransactionDetails": { "type": "boolean", "description": "Provides detailed transaction information from the source database. Default is `false`.\n" }, "messageFormat": { "type": "string", "description": "Output format for the records created. Default is `json`. Valid values are `json` and `json-unformatted` (a single line with no tab).\n", "willReplaceOnChanges": true }, "partitionIncludeSchemaTable": { "type": "boolean", "description": "Prefixes schema and table names to partition values, when the partition type is primary-key-type. Default is `false`.\n" }, "serviceAccessRoleArn": { "type": "string", "description": "ARN of the IAM Role with permissions to write to the Kinesis data stream.\n" }, "streamArn": { "type": "string", "description": "ARN of the Kinesis data stream.\n" } }, "type": "object" }, "aws:dms/EndpointMongodbSettings:EndpointMongodbSettings": { "properties": { "authMechanism": { "type": "string", "description": "Authentication mechanism to access the MongoDB source endpoint. Default is `default`.\n" }, "authSource": { "type": "string", "description": "Authentication database name. Not used when `auth_type` is `no`. Default is `admin`.\n" }, "authType": { "type": "string", "description": "Authentication type to access the MongoDB source endpoint. Default is `password`.\n" }, "docsToInvestigate": { "type": "string", "description": "Number of documents to preview to determine the document organization. Use this setting when `nesting_level` is set to `one`. Default is `1000`.\n" }, "extractDocId": { "type": "string", "description": "Document ID. Use this setting when `nesting_level` is set to `none`. Default is `false`.\n" }, "nestingLevel": { "type": "string", "description": "Specifies either document or table mode. Default is `none`. Valid values are `one` (table mode) and `none` (document mode).\n" } }, "type": "object" }, "aws:dms/EndpointPostgresSettings:EndpointPostgresSettings": { "properties": { "afterConnectScript": { "type": "string", "description": "For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.\n" }, "babelfishDatabaseName": { "type": "string", "description": "The Babelfish for Aurora PostgreSQL database name for the endpoint.\n" }, "captureDdls": { "type": "boolean", "description": "To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.\n" }, "databaseMode": { "type": "string", "description": "Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.\n" }, "ddlArtifactsSchema": { "type": "string", "description": "Sets the schema in which the operational DDL database artifacts are created. Default is `public`.\n" }, "executeTimeout": { "type": "integer", "description": "Sets the client statement timeout for the PostgreSQL instance, in seconds. Default value is `60`.\n" }, "failTasksOnLobTruncation": { "type": "boolean", "description": "When set to `true`, this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize`. Default is `false`.\n" }, "heartbeatEnable": { "type": "boolean", "description": "The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source.\n" }, "heartbeatFrequency": { "type": "integer", "description": "Sets the WAL heartbeat frequency (in minutes). Default value is `5`.\n" }, "heartbeatSchema": { "type": "string", "description": "Sets the schema in which the heartbeat artifacts are created. Default value is `public`.\n" }, "mapBooleanAsBoolean": { "type": "boolean", "description": "You can use PostgreSQL endpoint settings to map a boolean as a boolean from your PostgreSQL source to a Amazon Redshift target. Default value is `false`.\n" }, "mapJsonbAsClob": { "type": "boolean", "description": "Optional When true, DMS migrates JSONB values as CLOB.\n" }, "mapLongVarcharAs": { "type": "string", "description": "Optional When true, DMS migrates LONG values as VARCHAR.\n" }, "maxFileSize": { "type": "integer", "description": "Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Default is `32,768 KB`.\n" }, "pluginName": { "type": "string", "description": "Specifies the plugin to use to create a replication slot. Valid values: `pglogical`, `test_decoding`.\n" }, "slotName": { "type": "string", "description": "Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.\n" } }, "type": "object" }, "aws:dms/EndpointRedisSettings:EndpointRedisSettings": { "properties": { "authPassword": { "type": "string", "description": "The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.\n", "secret": true }, "authType": { "type": "string", "description": "The type of authentication to perform when connecting to a Redis target. Options include `none`, `auth-token`, and `auth-role`. The `auth-token` option requires an `auth_password` value to be provided. The `auth-role` option requires `auth_user_name` and `auth_password` values to be provided.\n" }, "authUserName": { "type": "string", "description": "The username provided with the `auth-role` option of the AuthType setting for a Redis target endpoint.\n" }, "port": { "type": "integer", "description": "Transmission Control Protocol (TCP) port for the endpoint.\n" }, "serverName": { "type": "string", "description": "Fully qualified domain name of the endpoint.\n" }, "sslCaCertificateArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.\n" }, "sslSecurityProtocol": { "type": "string", "description": "The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database. Options include `plaintext`, `ssl-encryption`. The default is `ssl-encryption`.\n" } }, "type": "object", "required": [ "authType", "port", "serverName" ] }, "aws:dms/EndpointRedshiftSettings:EndpointRedshiftSettings": { "properties": { "bucketFolder": { "type": "string", "description": "Custom S3 Bucket Object prefix for intermediate storage.\n" }, "bucketName": { "type": "string", "description": "Custom S3 Bucket name for intermediate storage.\n" }, "encryptionMode": { "type": "string", "description": "The server-side encryption mode that you want to encrypt your intermediate .csv object files copied to S3. Defaults to `SSE_S3`. Valid values are `SSE_S3` and `SSE_KMS`.\n" }, "serverSideEncryptionKmsKeyId": { "type": "string", "description": "ARN or Id of KMS Key to use when `encryption_mode` is `SSE_KMS`.\n" }, "serviceAccessRoleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket for intermediate storage.\n" } }, "type": "object" }, "aws:dms/EndpointS3Settings:EndpointS3Settings": { "properties": { "addColumnName": { "type": "boolean", "description": "Whether to add column name information to the .csv output file. Default is `false`.\n" }, "bucketFolder": { "type": "string", "description": "S3 object prefix.\n" }, "bucketName": { "type": "string", "description": "S3 bucket name.\n" }, "cannedAclForObjects": { "type": "string", "description": "Predefined (canned) access control list for objects created in an S3 bucket. Valid values include `none`, `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Default is `none`.\n" }, "cdcInsertsAndUpdates": { "type": "boolean", "description": "Whether to write insert and update operations to .csv or .parquet output files. Default is `false`.\n" }, "cdcInsertsOnly": { "type": "boolean", "description": "Whether to write insert operations to .csv or .parquet output files. Default is `false`.\n" }, "cdcMaxBatchInterval": { "type": "integer", "description": "Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. Default is `60`.\n" }, "cdcMinFileSize": { "type": "integer", "description": "Minimum file size condition as defined in kilobytes to output a file to Amazon S3. Default is `32000`. **NOTE:** Previously, this setting was measured in megabytes but now represents kilobytes. Update configurations accordingly.\n" }, "cdcPath": { "type": "string", "description": "Folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `cdc_path` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later.\n" }, "compressionType": { "type": "string", "description": "Set to compress target files. Default is `NONE`. Valid values are `GZIP` and `NONE`.\n" }, "csvDelimiter": { "type": "string", "description": "Delimiter used to separate columns in the source files. Default is `,`.\n" }, "csvNoSupValue": { "type": "string", "description": "String to use for all columns not included in the supplemental log.\n" }, "csvNullValue": { "type": "string", "description": "String to as null when writing to the target.\n" }, "csvRowDelimiter": { "type": "string", "description": "Delimiter used to separate rows in the source files. Default is `\\n`.\n" }, "dataFormat": { "type": "string", "description": "Output format for the files that AWS DMS uses to create S3 objects. Valid values are `csv` and `parquet`. Default is `csv`.\n" }, "dataPageSize": { "type": "integer", "description": "Size of one data page in bytes. Default is `1048576` (1 MiB).\n" }, "datePartitionDelimiter": { "type": "string", "description": "Date separating delimiter to use during folder partitioning. Valid values are `SLASH`, `UNDERSCORE`, `DASH`, and `NONE`. Default is `SLASH`.\n" }, "datePartitionEnabled": { "type": "boolean", "description": "Partition S3 bucket folders based on transaction commit dates. Default is `false`.\n" }, "datePartitionSequence": { "type": "string", "description": "Date format to use during folder partitioning. Use this parameter when `date_partition_enabled` is set to true. Valid values are `YYYYMMDD`, `YYYYMMDDHH`, `YYYYMM`, `MMYYYYDD`, and `DDMMYYYY`. Default is `YYYYMMDD`.\n" }, "dictPageSizeLimit": { "type": "integer", "description": "Maximum size in bytes of an encoded dictionary page of a column. Default is `1048576` (1 MiB).\n" }, "enableStatistics": { "type": "boolean", "description": "Whether to enable statistics for Parquet pages and row groups. Default is `true`.\n" }, "encodingType": { "type": "string", "description": "Type of encoding to use. Value values are `rle_dictionary`, `plain`, and `plain_dictionary`. Default is `rle_dictionary`.\n" }, "encryptionMode": { "type": "string", "description": "Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are `SSE_S3` and `SSE_KMS`. Default is `SSE_S3`.\n" }, "externalTableDefinition": { "type": "string", "description": "JSON document that describes how AWS DMS should interpret the data.\n" }, "glueCatalogGeneration": { "type": "boolean", "description": "Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See [Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.GlueCatalog) for more information. Default is `false`.\n" }, "ignoreHeaderRows": { "type": "integer", "description": "When this value is set to `1`, DMS ignores the first row header in a .csv file. Default is `0`.\n" }, "includeOpForFullLoad": { "type": "boolean", "description": "Whether to enable a full load to write INSERT operations to the .csv output files only to indicate how the rows were added to the source database. Default is `false`.\n" }, "maxFileSize": { "type": "integer", "description": "Maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from `1` to `1048576`. Default is `1048576` (1 GB).\n" }, "parquetTimestampInMillisecond": { "type": "boolean", "description": "Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is `false`.\n" }, "parquetVersion": { "type": "string", "description": "Version of the .parquet file format. Default is `parquet-1-0`. Valid values are `parquet-1-0` and `parquet-2-0`.\n" }, "preserveTransactions": { "type": "boolean", "description": "Whether DMS saves the transaction order for a CDC load on the S3 target specified by `cdc_path`. Default is `false`.\n" }, "rfc4180": { "type": "boolean", "description": "For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is `true`.\n" }, "rowGroupLength": { "type": "integer", "description": "Number of rows in a row group. Default is `10000`.\n" }, "serverSideEncryptionKmsKeyId": { "type": "string", "description": "ARN or Id of KMS Key to use when `encryption_mode` is `SSE_KMS`.\n" }, "serviceAccessRoleArn": { "type": "string", "description": "ARN of the IAM Role with permissions to read from or write to the S3 Bucket.\n" }, "timestampColumnName": { "type": "string", "description": "Column to add with timestamp information to the endpoint data for an Amazon S3 target.\n" }, "useCsvNoSupValue": { "type": "boolean", "description": "Whether to use `csv_no_sup_value` for columns not included in the supplemental log.\n" }, "useTaskStartTimeForFullLoadTimestamp": { "type": "boolean", "description": "When set to true, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. When set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target. Default is `false`.\n" } }, "type": "object" }, "aws:dms/ReplicationConfigComputeConfig:ReplicationConfigComputeConfig": { "properties": { "availabilityZone": { "type": "string", "description": "The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.\n", "willReplaceOnChanges": true }, "dnsNameServers": { "type": "string", "description": "A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.\n" }, "kmsKeyId": { "type": "string", "description": "An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.\n", "willReplaceOnChanges": true }, "maxCapacityUnits": { "type": "integer", "description": "Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCUs as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.\n" }, "minCapacityUnits": { "type": "integer", "description": "Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS sets the lowest allowed value, 1.\n" }, "multiAz": { "type": "boolean", "description": "Specifies if the replication instance is a multi-az deployment. You cannot set the `availability_zone` parameter if the `multi_az` parameter is set to `true`.\n" }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n\n- Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.\n- Format: `ddd:hh24:mi-ddd:hh24:mi`\n- Valid Days: `mon, tue, wed, thu, fri, sat, sun`\n- Constraints: Minimum 30-minute window.\n" }, "replicationSubnetGroupId": { "type": "string", "description": "Specifies a subnet group identifier to associate with the DMS Serverless replication.\n", "willReplaceOnChanges": true }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.\n" } }, "type": "object", "required": [ "replicationSubnetGroupId" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityZone", "kmsKeyId", "multiAz", "preferredMaintenanceWindow", "replicationSubnetGroupId", "vpcSecurityGroupIds" ] } } }, "aws:dms/getEndpointElasticsearchSetting:getEndpointElasticsearchSetting": { "properties": { "endpointUri": { "type": "string" }, "errorRetryDuration": { "type": "integer" }, "fullLoadErrorPercentage": { "type": "integer" }, "serviceAccessRoleArn": { "type": "string" } }, "type": "object", "required": [ "endpointUri", "errorRetryDuration", "fullLoadErrorPercentage", "serviceAccessRoleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointKafkaSetting:getEndpointKafkaSetting": { "properties": { "broker": { "type": "string" }, "includeControlDetails": { "type": "boolean" }, "includeNullAndEmpty": { "type": "boolean" }, "includePartitionValue": { "type": "boolean" }, "includeTableAlterOperations": { "type": "boolean" }, "includeTransactionDetails": { "type": "boolean" }, "messageFormat": { "type": "string" }, "messageMaxBytes": { "type": "integer" }, "noHexPrefix": { "type": "boolean" }, "partitionIncludeSchemaTable": { "type": "boolean" }, "saslMechanism": { "type": "string" }, "saslPassword": { "type": "string" }, "saslUsername": { "type": "string" }, "securityProtocol": { "type": "string" }, "sslCaCertificateArn": { "type": "string" }, "sslClientCertificateArn": { "type": "string" }, "sslClientKeyArn": { "type": "string" }, "sslClientKeyPassword": { "type": "string" }, "topic": { "type": "string" } }, "type": "object", "required": [ "broker", "includeControlDetails", "includeNullAndEmpty", "includePartitionValue", "includeTableAlterOperations", "includeTransactionDetails", "messageFormat", "messageMaxBytes", "noHexPrefix", "partitionIncludeSchemaTable", "saslMechanism", "saslPassword", "saslUsername", "securityProtocol", "sslCaCertificateArn", "sslClientCertificateArn", "sslClientKeyArn", "sslClientKeyPassword", "topic" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointKinesisSetting:getEndpointKinesisSetting": { "properties": { "includeControlDetails": { "type": "boolean" }, "includeNullAndEmpty": { "type": "boolean" }, "includePartitionValue": { "type": "boolean" }, "includeTableAlterOperations": { "type": "boolean" }, "includeTransactionDetails": { "type": "boolean" }, "messageFormat": { "type": "string" }, "partitionIncludeSchemaTable": { "type": "boolean" }, "serviceAccessRoleArn": { "type": "string" }, "streamArn": { "type": "string" } }, "type": "object", "required": [ "includeControlDetails", "includeNullAndEmpty", "includePartitionValue", "includeTableAlterOperations", "includeTransactionDetails", "messageFormat", "partitionIncludeSchemaTable", "serviceAccessRoleArn", "streamArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointMongodbSetting:getEndpointMongodbSetting": { "properties": { "authMechanism": { "type": "string" }, "authSource": { "type": "string" }, "authType": { "type": "string" }, "docsToInvestigate": { "type": "string" }, "extractDocId": { "type": "string" }, "nestingLevel": { "type": "string" } }, "type": "object", "required": [ "authMechanism", "authSource", "authType", "docsToInvestigate", "extractDocId", "nestingLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointPostgresSetting:getEndpointPostgresSetting": { "properties": { "afterConnectScript": { "type": "string" }, "babelfishDatabaseName": { "type": "string" }, "captureDdls": { "type": "boolean" }, "databaseMode": { "type": "string" }, "ddlArtifactsSchema": { "type": "string" }, "executeTimeout": { "type": "integer" }, "failTasksOnLobTruncation": { "type": "boolean" }, "heartbeatEnable": { "type": "boolean" }, "heartbeatFrequency": { "type": "integer" }, "heartbeatSchema": { "type": "string" }, "mapBooleanAsBoolean": { "type": "boolean" }, "mapJsonbAsClob": { "type": "boolean" }, "mapLongVarcharAs": { "type": "string" }, "maxFileSize": { "type": "integer" }, "pluginName": { "type": "string" }, "slotName": { "type": "string" } }, "type": "object", "required": [ "afterConnectScript", "babelfishDatabaseName", "captureDdls", "databaseMode", "ddlArtifactsSchema", "executeTimeout", "failTasksOnLobTruncation", "heartbeatEnable", "heartbeatFrequency", "heartbeatSchema", "mapBooleanAsBoolean", "mapJsonbAsClob", "mapLongVarcharAs", "maxFileSize", "pluginName", "slotName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointRedisSetting:getEndpointRedisSetting": { "properties": { "authPassword": { "type": "string" }, "authType": { "type": "string" }, "authUserName": { "type": "string" }, "port": { "type": "integer" }, "serverName": { "type": "string" }, "sslCaCertificateArn": { "type": "string" }, "sslSecurityProtocol": { "type": "string" } }, "type": "object", "required": [ "authPassword", "authType", "authUserName", "port", "serverName", "sslCaCertificateArn", "sslSecurityProtocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointRedshiftSetting:getEndpointRedshiftSetting": { "properties": { "bucketFolder": { "type": "string" }, "bucketName": { "type": "string" }, "encryptionMode": { "type": "string" }, "serverSideEncryptionKmsKeyId": { "type": "string" }, "serviceAccessRoleArn": { "type": "string" } }, "type": "object", "required": [ "bucketFolder", "bucketName", "encryptionMode", "serverSideEncryptionKmsKeyId", "serviceAccessRoleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dms/getEndpointS3Setting:getEndpointS3Setting": { "properties": { "addColumnName": { "type": "boolean" }, "bucketFolder": { "type": "string" }, "bucketName": { "type": "string" }, "cannedAclForObjects": { "type": "string" }, "cdcInsertsAndUpdates": { "type": "boolean" }, "cdcInsertsOnly": { "type": "boolean" }, "cdcMaxBatchInterval": { "type": "integer" }, "cdcMinFileSize": { "type": "integer" }, "cdcPath": { "type": "string" }, "compressionType": { "type": "string" }, "csvDelimiter": { "type": "string" }, "csvNoSupValue": { "type": "string" }, "csvNullValue": { "type": "string" }, "csvRowDelimiter": { "type": "string" }, "dataFormat": { "type": "string" }, "dataPageSize": { "type": "integer" }, "datePartitionDelimiter": { "type": "string" }, "datePartitionEnabled": { "type": "boolean" }, "datePartitionSequence": { "type": "string" }, "dictPageSizeLimit": { "type": "integer" }, "enableStatistics": { "type": "boolean" }, "encodingType": { "type": "string" }, "encryptionMode": { "type": "string" }, "externalTableDefinition": { "type": "string" }, "glueCatalogGeneration": { "type": "boolean" }, "ignoreHeaderRows": { "type": "integer" }, "ignoreHeadersRow": { "type": "integer" }, "includeOpForFullLoad": { "type": "boolean" }, "maxFileSize": { "type": "integer" }, "parquetTimestampInMillisecond": { "type": "boolean" }, "parquetVersion": { "type": "string" }, "preserveTransactions": { "type": "boolean" }, "rfc4180": { "type": "boolean" }, "rowGroupLength": { "type": "integer" }, "serverSideEncryptionKmsKeyId": { "type": "string" }, "serviceAccessRoleArn": { "type": "string" }, "timestampColumnName": { "type": "string" }, "useCsvNoSupValue": { "type": "boolean" }, "useTaskStartTimeForFullLoadTimestamp": { "type": "boolean" } }, "type": "object", "required": [ "addColumnName", "bucketFolder", "bucketName", "cannedAclForObjects", "cdcInsertsAndUpdates", "cdcInsertsOnly", "cdcMaxBatchInterval", "cdcMinFileSize", "cdcPath", "compressionType", "csvDelimiter", "csvNoSupValue", "csvNullValue", "csvRowDelimiter", "dataFormat", "dataPageSize", "datePartitionDelimiter", "datePartitionEnabled", "datePartitionSequence", "dictPageSizeLimit", "enableStatistics", "encodingType", "encryptionMode", "externalTableDefinition", "glueCatalogGeneration", "ignoreHeaderRows", "ignoreHeadersRow", "includeOpForFullLoad", "maxFileSize", "parquetTimestampInMillisecond", "parquetVersion", "preserveTransactions", "rfc4180", "rowGroupLength", "serverSideEncryptionKmsKeyId", "serviceAccessRoleArn", "timestampColumnName", "useCsvNoSupValue", "useTaskStartTimeForFullLoadTimestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:docdb/ClusterParameterGroupParameter:ClusterParameterGroupParameter": { "properties": { "applyMethod": { "type": "string", "description": "Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`.\n" }, "name": { "type": "string", "description": "The name of the DocumentDB parameter.\n" }, "value": { "type": "string", "description": "The value of the DocumentDB parameter.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:docdb/ClusterRestoreToPointInTime:ClusterRestoreToPointInTime": { "properties": { "restoreToTime": { "type": "string", "description": "The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with `use_latest_restorable_time`.\n", "willReplaceOnChanges": true }, "restoreType": { "type": "string", "description": "The type of restore to be performed. Valid values are `full-copy`, `copy-on-write`.\n", "willReplaceOnChanges": true }, "sourceClusterIdentifier": { "type": "string", "description": "The identifier of the source DB cluster from which to restore. Must match the identifier of an existing DB cluster.\n", "willReplaceOnChanges": true }, "useLatestRestorableTime": { "type": "boolean", "description": "A boolean value that indicates whether the DB cluster is restored from the latest backup time. Defaults to `false`. Cannot be specified with `restore_to_time`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sourceClusterIdentifier" ] }, "aws:docdb/ElasticClusterTimeouts:ElasticClusterTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:docdb/GlobalClusterGlobalClusterMember:GlobalClusterGlobalClusterMember": { "properties": { "dbClusterArn": { "type": "string", "description": "Amazon Resource Name (ARN) of member DB Cluster.\n" }, "isWriter": { "type": "boolean", "description": "Whether the member is the primary DB Cluster.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dbClusterArn", "isWriter" ] } } }, "aws:drs/ReplicationConfigurationTemplatePitPolicy:ReplicationConfigurationTemplatePitPolicy": { "properties": { "enabled": { "type": "boolean", "description": "Whether this rule is enabled or not.\n" }, "interval": { "type": "integer", "description": "How often, in the chosen units, a snapshot should be taken.\n" }, "retentionDuration": { "type": "integer", "description": "Duration to retain a snapshot for, in the chosen `units`.\n" }, "ruleId": { "type": "integer", "description": "ID of the rule. Valid values are integers.\n" }, "units": { "type": "string", "description": "Units used to measure the `interval` and `retention_duration`. Valid values are `MINUTE`, `HOUR`, and `DAY`.\n" } }, "type": "object", "required": [ "interval", "retentionDuration", "units" ] }, "aws:drs/ReplicationConfigurationTemplateTimeouts:ReplicationConfigurationTemplateTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:dynamodb/GlobalTableReplica:GlobalTableReplica": { "properties": { "regionName": { "type": "string", "description": "AWS region name of replica DynamoDB TableE.g., `us-east-1`\n" } }, "type": "object", "required": [ "regionName" ] }, "aws:dynamodb/TableAttribute:TableAttribute": { "properties": { "name": { "type": "string", "description": "Name of the attribute\n" }, "type": { "type": "string", "description": "Attribute type. Valid values are `S` (string), `N` (number), `B` (binary).\n" } }, "type": "object", "required": [ "name", "type" ] }, "aws:dynamodb/TableExportIncrementalExportSpecification:TableExportIncrementalExportSpecification": { "properties": { "exportFromTime": { "type": "string", "willReplaceOnChanges": true }, "exportToTime": { "type": "string", "willReplaceOnChanges": true }, "exportViewType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "exportFromTime", "exportToTime", "exportViewType" ] } } }, "aws:dynamodb/TableGlobalSecondaryIndex:TableGlobalSecondaryIndex": { "properties": { "hashKey": { "type": "string", "description": "Name of the hash key in the index; must be defined as an attribute in the resource.\n" }, "name": { "type": "string", "description": "Name of the index.\n" }, "nonKeyAttributes": { "type": "array", "items": { "type": "string" }, "description": "Only required with `INCLUDE` as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.\n" }, "onDemandThroughput": { "$ref": "#/types/aws:dynamodb/TableGlobalSecondaryIndexOnDemandThroughput:TableGlobalSecondaryIndexOnDemandThroughput", "description": "Sets the maximum number of read and write units for the specified on-demand table. See below.\n" }, "projectionType": { "type": "string", "description": "One of `ALL`, `INCLUDE` or `KEYS_ONLY` where `ALL` projects every attribute into the index, `KEYS_ONLY` projects into the index only the table and index hash_key and sort_key attributes , `INCLUDE` projects into the index all of the attributes that are defined in `non_key_attributes` in addition to the attributes that that`KEYS_ONLY` project.\n" }, "rangeKey": { "type": "string", "description": "Name of the range key; must be defined\n" }, "readCapacity": { "type": "integer", "description": "Number of read units for this index. Must be set if billing_mode is set to PROVISIONED.\n" }, "writeCapacity": { "type": "integer", "description": "Number of write units for this index. Must be set if billing_mode is set to PROVISIONED.\n" } }, "type": "object", "required": [ "hashKey", "name", "projectionType" ], "language": { "nodejs": { "requiredOutputs": [ "hashKey", "name", "projectionType", "readCapacity", "writeCapacity" ] } } }, "aws:dynamodb/TableGlobalSecondaryIndexOnDemandThroughput:TableGlobalSecondaryIndexOnDemandThroughput": { "properties": { "maxReadRequestUnits": { "type": "integer", "description": "Maximum number of read request units for the specified table. To specify set the value greater than or equal to 1. To remove set the value to -1.\n" }, "maxWriteRequestUnits": { "type": "integer", "description": "Maximum number of write request units for the specified table. To specify set the value greater than or equal to 1. To remove set the value to -1.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxReadRequestUnits", "maxWriteRequestUnits" ] } } }, "aws:dynamodb/TableImportTable:TableImportTable": { "properties": { "inputCompressionType": { "type": "string", "description": "Type of compression to be used on the input coming from the imported table.\nValid values are `GZIP`, `ZSTD` and `NONE`.\n" }, "inputFormat": { "type": "string", "description": "The format of the source data.\nValid values are `CSV`, `DYNAMODB_JSON`, and `ION`.\n" }, "inputFormatOptions": { "$ref": "#/types/aws:dynamodb/TableImportTableInputFormatOptions:TableImportTableInputFormatOptions", "description": "Describe the format options for the data that was imported into the target table.\nThere is one value, `csv`.\nSee below.\n" }, "s3BucketSource": { "$ref": "#/types/aws:dynamodb/TableImportTableS3BucketSource:TableImportTableS3BucketSource", "description": "Values for the S3 bucket the source file is imported from.\nSee below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "inputFormat", "s3BucketSource" ] }, "aws:dynamodb/TableImportTableInputFormatOptions:TableImportTableInputFormatOptions": { "properties": { "csv": { "$ref": "#/types/aws:dynamodb/TableImportTableInputFormatOptionsCsv:TableImportTableInputFormatOptionsCsv", "description": "This block contains the processing options for the CSV file being imported:\n" } }, "type": "object" }, "aws:dynamodb/TableImportTableInputFormatOptionsCsv:TableImportTableInputFormatOptionsCsv": { "properties": { "delimiter": { "type": "string", "description": "The delimiter used for separating items in the CSV file being imported.\n" }, "headerLists": { "type": "array", "items": { "type": "string" }, "description": "List of the headers used to specify a common header for all source CSV files being imported.\n" } }, "type": "object" }, "aws:dynamodb/TableImportTableS3BucketSource:TableImportTableS3BucketSource": { "properties": { "bucket": { "type": "string", "description": "The S3 bucket that is being imported from.\n" }, "bucketOwner": { "type": "string", "description": "The account number of the S3 bucket that is being imported from.\n" }, "keyPrefix": { "type": "string", "description": "The key prefix shared by all S3 Objects that are being imported.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:dynamodb/TableLocalSecondaryIndex:TableLocalSecondaryIndex": { "properties": { "name": { "type": "string", "description": "Name of the index\n", "willReplaceOnChanges": true }, "nonKeyAttributes": { "type": "array", "items": { "type": "string" }, "description": "Only required with `INCLUDE` as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.\n", "willReplaceOnChanges": true }, "projectionType": { "type": "string", "description": "One of `ALL`, `INCLUDE` or `KEYS_ONLY` where `ALL` projects every attribute into the index, `KEYS_ONLY` projects into the index only the table and index hash_key and sort_key attributes , `INCLUDE` projects into the index all of the attributes that are defined in `non_key_attributes` in addition to the attributes that that`KEYS_ONLY` project.\n", "willReplaceOnChanges": true }, "rangeKey": { "type": "string", "description": "Name of the range key.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "projectionType", "rangeKey" ] }, "aws:dynamodb/TableOnDemandThroughput:TableOnDemandThroughput": { "properties": { "maxReadRequestUnits": { "type": "integer", "description": "Maximum number of read request units for the specified table. To specify set the value greater than or equal to 1. To remove set the value to -1.\n" }, "maxWriteRequestUnits": { "type": "integer", "description": "Maximum number of write request units for the specified table. To specify set the value greater than or equal to 1. To remove set the value to -1.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxReadRequestUnits", "maxWriteRequestUnits" ] } } }, "aws:dynamodb/TablePointInTimeRecovery:TablePointInTimeRecovery": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable point-in-time recovery. It can take 10 minutes to enable for new tables. If the `point_in_time_recovery` block is not provided, this defaults to `false`.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:dynamodb/TableReplica:TableReplica": { "properties": { "arn": { "type": "string", "description": "ARN of the table\n" }, "kmsKeyArn": { "type": "string", "description": "ARN of the CMK that should be used for the AWS KMS encryption.\nThis argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`.\n**Note:** This attribute will _not_ be populated with the ARN of _default_ keys.\n**Note:** Changing this value will recreate the replica.\n" }, "pointInTimeRecovery": { "type": "boolean", "description": "Whether to enable Point In Time Recovery for the replica. Default is `false`.\n" }, "propagateTags": { "type": "boolean", "description": "Whether to propagate the global table's tags to a replica.\nDefault is `false`.\nChanges to tags only move in one direction: from global (source) to replica.\nTag drift on a replica will not trigger an update.\nTag changes on the global table are propagated to replicas.\nChanging from `true` to `false` on a subsequent `apply` leaves replica tags as-is and no longer manages them.\n" }, "regionName": { "type": "string", "description": "Region name of the replica.\n" }, "streamArn": { "type": "string", "description": "ARN of the Table Stream. Only available when `stream_enabled = true`\n" }, "streamLabel": { "type": "string", "description": "Timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `stream_enabled = true`.\n" } }, "type": "object", "required": [ "regionName" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "kmsKeyArn", "regionName", "streamArn", "streamLabel" ] } } }, "aws:dynamodb/TableServerSideEncryption:TableServerSideEncryption": { "properties": { "enabled": { "type": "boolean", "description": "Whether or not to enable encryption at rest using an AWS managed KMS customer master key (CMK). If `enabled` is `false` then server-side encryption is set to AWS-_owned_ key (shown as `DEFAULT` in the AWS console). Potentially confusingly, if `enabled` is `true` and no `kms_key_arn` is specified then server-side encryption is set to the _default_ KMS-_managed_ key (shown as `KMS` in the AWS console). The [AWS KMS documentation](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) explains the difference between AWS-_owned_ and KMS-_managed_ keys.\n" }, "kmsKeyArn": { "type": "string", "description": "ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "enabled", "kmsKeyArn" ] } } }, "aws:dynamodb/TableTtl:TableTtl": { "properties": { "attributeName": { "type": "string", "description": "Name of the table attribute to store the TTL timestamp in.\nRequired if `enabled` is `true`, must not be set otherwise.\n" }, "enabled": { "type": "boolean", "description": "Whether TTL is enabled.\nDefault value is `false`.\n" } }, "type": "object" }, "aws:dynamodb/getTableAttribute:getTableAttribute": { "properties": { "name": { "type": "string", "description": "Name of the DynamoDB table.\n" }, "type": { "type": "string" } }, "type": "object", "required": [ "name", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableGlobalSecondaryIndex:getTableGlobalSecondaryIndex": { "properties": { "hashKey": { "type": "string" }, "name": { "type": "string", "description": "Name of the DynamoDB table.\n" }, "nonKeyAttributes": { "type": "array", "items": { "type": "string" } }, "onDemandThroughputs": { "type": "array", "items": { "$ref": "#/types/aws:dynamodb/getTableGlobalSecondaryIndexOnDemandThroughput:getTableGlobalSecondaryIndexOnDemandThroughput" } }, "projectionType": { "type": "string" }, "rangeKey": { "type": "string" }, "readCapacity": { "type": "integer" }, "writeCapacity": { "type": "integer" } }, "type": "object", "required": [ "hashKey", "name", "nonKeyAttributes", "onDemandThroughputs", "projectionType", "rangeKey", "readCapacity", "writeCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableGlobalSecondaryIndexOnDemandThroughput:getTableGlobalSecondaryIndexOnDemandThroughput": { "properties": { "maxReadRequestUnits": { "type": "integer" }, "maxWriteRequestUnits": { "type": "integer" } }, "type": "object", "required": [ "maxReadRequestUnits", "maxWriteRequestUnits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableLocalSecondaryIndex:getTableLocalSecondaryIndex": { "properties": { "name": { "type": "string", "description": "Name of the DynamoDB table.\n" }, "nonKeyAttributes": { "type": "array", "items": { "type": "string" } }, "projectionType": { "type": "string" }, "rangeKey": { "type": "string" } }, "type": "object", "required": [ "name", "nonKeyAttributes", "projectionType", "rangeKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableOnDemandThroughput:getTableOnDemandThroughput": { "properties": { "maxReadRequestUnits": { "type": "integer" }, "maxWriteRequestUnits": { "type": "integer" } }, "type": "object", "required": [ "maxReadRequestUnits", "maxWriteRequestUnits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTablePointInTimeRecovery:getTablePointInTimeRecovery": { "properties": { "enabled": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableReplica:getTableReplica": { "properties": { "kmsKeyArn": { "type": "string" }, "regionName": { "type": "string" } }, "type": "object", "required": [ "kmsKeyArn", "regionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableServerSideEncryption:getTableServerSideEncryption": { "properties": { "enabled": { "type": "boolean" }, "kmsKeyArn": { "type": "string" } }, "type": "object", "required": [ "enabled", "kmsKeyArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:dynamodb/getTableTtl:getTableTtl": { "properties": { "attributeName": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object", "required": [ "attributeName", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ebs/FastSnapshotRestoreTimeouts:FastSnapshotRestoreTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:ebs/SnapshotImportClientData:SnapshotImportClientData": { "properties": { "comment": { "type": "string", "description": "A user-defined comment about the disk upload.\n", "willReplaceOnChanges": true }, "uploadEnd": { "type": "string", "description": "The time that the disk upload ends.\n" }, "uploadSize": { "type": "number", "description": "The size of the uploaded disk image, in GiB.\n" }, "uploadStart": { "type": "string", "description": "The time that the disk upload starts.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "uploadEnd", "uploadSize", "uploadStart" ] } } }, "aws:ebs/SnapshotImportDiskContainer:SnapshotImportDiskContainer": { "properties": { "description": { "type": "string", "description": "The description of the disk image being imported.\n", "willReplaceOnChanges": true }, "format": { "type": "string", "description": "The format of the disk image being imported. One of `VHD` or `VMDK`.\n", "willReplaceOnChanges": true }, "url": { "type": "string", "description": "The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of `url` or `user_bucket` must be set.\n", "willReplaceOnChanges": true }, "userBucket": { "$ref": "#/types/aws:ebs/SnapshotImportDiskContainerUserBucket:SnapshotImportDiskContainerUserBucket", "description": "The Amazon S3 bucket for the disk image. One of `url` or `user_bucket` must be set. Detailed below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "format" ] }, "aws:ebs/SnapshotImportDiskContainerUserBucket:SnapshotImportDiskContainerUserBucket": { "properties": { "s3Bucket": { "type": "string", "description": "The name of the Amazon S3 bucket where the disk image is located.\n", "willReplaceOnChanges": true }, "s3Key": { "type": "string", "description": "The file name of the disk image.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "s3Bucket", "s3Key" ] }, "aws:ebs/getEbsVolumesFilter:getEbsVolumesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVolumes.html).\nFor example, if matching against the `size` filter, use:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst tenOrTwentyGbVolumes = aws.ebs.getEbsVolumes({\n filters: [{\n name: \"size\",\n values: [\n \"10\",\n \"20\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\nten_or_twenty_gb_volumes = aws.ebs.get_ebs_volumes(filters=[{\n \"name\": \"size\",\n \"values\": [\n \"10\",\n \"20\",\n ],\n}])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tenOrTwentyGbVolumes = Aws.Ebs.GetEbsVolumes.Invoke(new()\n {\n Filters = new[]\n {\n new Aws.Ebs.Inputs.GetEbsVolumesFilterInputArgs\n {\n Name = \"size\",\n Values = new[]\n {\n \"10\",\n \"20\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ebs\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ebs.GetEbsVolumes(ctx, \u0026ebs.GetEbsVolumesArgs{\n\t\t\tFilters: []ebs.GetEbsVolumesFilter{\n\t\t\t\t{\n\t\t\t\t\tName: \"size\",\n\t\t\t\t\tValues: []string{\n\t\t\t\t\t\t\"10\",\n\t\t\t\t\t\t\"20\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.ebs.EbsFunctions;\nimport com.pulumi.aws.ebs.inputs.GetEbsVolumesArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var tenOrTwentyGbVolumes = EbsFunctions.getEbsVolumes(GetEbsVolumesArgs.builder()\n .filters(GetEbsVolumesFilterArgs.builder()\n .name(\"size\")\n .values( \n \"10\",\n \"20\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nvariables:\n tenOrTwentyGbVolumes:\n fn::invoke:\n function: aws:ebs:getEbsVolumes\n arguments:\n filters:\n - name: size\n values:\n - '10'\n - '20'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nEBS Volume IDs will be selected if any one of the given values match.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ebs/getSnapshotFilter:getSnapshotFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ebs/getSnapshotIdsFilter:getSnapshotIdsFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ebs/getVolumeFilter:getVolumeFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/AmiCopyEbsBlockDevice:AmiCopyEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Boolean controlling whether the EBS volumes created to\nsupport each created instance will be deleted once that instance is terminated.\n" }, "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n" }, "encrypted": { "type": "boolean", "description": "Boolean controlling whether the created EBS volumes will be encrypted. Can't be used with `snapshot_id`.\n" }, "iops": { "type": "integer", "description": "Number of I/O operations per second the\ncreated volumes will support.\n" }, "outpostArn": { "type": "string", "description": "ARN of the Outpost on which the snapshot is stored.\n\n\u003e **Note:** You can specify `encrypted` or `snapshot_id` but not both.\n" }, "snapshotId": { "type": "string", "description": "ID of an EBS snapshot that will be used to initialize the created\nEBS volumes. If set, the `volume_size` attribute must be at least as large as the referenced\nsnapshot.\n" }, "throughput": { "type": "integer", "description": "Throughput that the EBS volume supports, in MiB/s. Only valid for `volume_type` of `gp3`.\n" }, "volumeSize": { "type": "integer", "description": "Size of created volumes in GiB.\nIf `snapshot_id` is set and `volume_size` is omitted then the volume will have the same size\nas the selected snapshot.\n" }, "volumeType": { "type": "string", "description": "Type of EBS volume to create. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `standard`).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteOnTermination", "deviceName", "encrypted", "iops", "outpostArn", "snapshotId", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/AmiCopyEphemeralBlockDevice:AmiCopyEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n" }, "virtualName": { "type": "string", "description": "Name for the ephemeral device, of the form \"ephemeralN\" where\n*N* is a volume number starting from zero.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deviceName", "virtualName" ] } } }, "aws:ec2/AmiEbsBlockDevice:AmiEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Boolean controlling whether the EBS volumes created to\nsupport each created instance will be deleted once that instance is terminated.\n", "willReplaceOnChanges": true }, "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "description": "Boolean controlling whether the created EBS volumes will be encrypted. Can't be used with `snapshot_id`.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Number of I/O operations per second the\ncreated volumes will support.\n", "willReplaceOnChanges": true }, "outpostArn": { "type": "string", "description": "ARN of the Outpost on which the snapshot is stored.\n\n\u003e **Note:** You can specify `encrypted` or `snapshot_id` but not both.\n", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "description": "ID of an EBS snapshot that will be used to initialize the created\nEBS volumes. If set, the `volume_size` attribute must be at least as large as the referenced\nsnapshot.\n", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "description": "Throughput that the EBS volume supports, in MiB/s. Only valid for `volume_type` of `gp3`.\n", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "description": "Size of created volumes in GiB.\nIf `snapshot_id` is set and `volume_size` is omitted then the volume will have the same size\nas the selected snapshot.\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "Type of EBS volume to create. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `standard`).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredOutputs": [ "deviceName", "throughput", "volumeSize" ] } } }, "aws:ec2/AmiEphemeralBlockDevice:AmiEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n" }, "virtualName": { "type": "string", "description": "Name for the ephemeral device, of the form \"ephemeralN\" where\n*N* is a volume number starting from zero.\n" } }, "type": "object", "required": [ "deviceName", "virtualName" ] }, "aws:ec2/AmiFromInstanceEbsBlockDevice:AmiFromInstanceEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Boolean controlling whether the EBS volumes created to\nsupport each created instance will be deleted once that instance is terminated.\n" }, "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n" }, "encrypted": { "type": "boolean", "description": "Boolean controlling whether the created EBS volumes will be encrypted. Can't be used with `snapshot_id`.\n" }, "iops": { "type": "integer", "description": "Number of I/O operations per second the\ncreated volumes will support.\n" }, "outpostArn": { "type": "string", "description": "ARN of the Outpost on which the snapshot is stored.\n\n\u003e **Note:** You can specify `encrypted` or `snapshot_id` but not both.\n" }, "snapshotId": { "type": "string", "description": "ID of an EBS snapshot that will be used to initialize the created\nEBS volumes. If set, the `volume_size` attribute must be at least as large as the referenced\nsnapshot.\n" }, "throughput": { "type": "integer", "description": "Throughput that the EBS volume supports, in MiB/s. Only valid for `volume_type` of `gp3`.\n" }, "volumeSize": { "type": "integer", "description": "Size of created volumes in GiB.\nIf `snapshot_id` is set and `volume_size` is omitted then the volume will have the same size\nas the selected snapshot.\n" }, "volumeType": { "type": "string", "description": "Type of EBS volume to create. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `standard`).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteOnTermination", "deviceName", "encrypted", "iops", "outpostArn", "snapshotId", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/AmiFromInstanceEphemeralBlockDevice:AmiFromInstanceEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Path at which the device is exposed to created instances.\n" }, "virtualName": { "type": "string", "description": "Name for the ephemeral device, of the form \"ephemeralN\" where\n*N* is a volume number starting from zero.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deviceName", "virtualName" ] } } }, "aws:ec2/CapacityBlockReservationTimeouts:CapacityBlockReservationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2/DefaultNetworkAclEgress:DefaultNetworkAclEgress": { "properties": { "action": { "type": "string", "description": "The action to take.\n" }, "cidrBlock": { "type": "string", "description": "The CIDR block to match. This must be a valid network mask.\n" }, "fromPort": { "type": "integer", "description": "The from port to match.\n" }, "icmpCode": { "type": "integer", "description": "The ICMP type code to be used. Default 0.\n" }, "icmpType": { "type": "integer", "description": "The ICMP type to be used. Default 0.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block.\n\n\u003e For more information on ICMP types and codes, see [Internet Control Message Protocol (ICMP) Parameters](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).\n" }, "protocol": { "type": "string", "description": "The protocol to match. If using the -1 'all' protocol, you must specify a from and to port of 0.\n" }, "ruleNo": { "type": "integer", "description": "The rule number. Used for ordering.\n" }, "toPort": { "type": "integer", "description": "The to port to match.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "action", "fromPort", "protocol", "ruleNo", "toPort" ] }, "aws:ec2/DefaultNetworkAclIngress:DefaultNetworkAclIngress": { "properties": { "action": { "type": "string", "description": "The action to take.\n" }, "cidrBlock": { "type": "string", "description": "The CIDR block to match. This must be a valid network mask.\n" }, "fromPort": { "type": "integer", "description": "The from port to match.\n" }, "icmpCode": { "type": "integer", "description": "The ICMP type code to be used. Default 0.\n" }, "icmpType": { "type": "integer", "description": "The ICMP type to be used. Default 0.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block.\n\n\u003e For more information on ICMP types and codes, see [Internet Control Message Protocol (ICMP) Parameters](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).\n" }, "protocol": { "type": "string", "description": "The protocol to match. If using the -1 'all' protocol, you must specify a from and to port of 0.\n" }, "ruleNo": { "type": "integer", "description": "The rule number. Used for ordering.\n" }, "toPort": { "type": "integer", "description": "The to port to match.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "action", "fromPort", "protocol", "ruleNo", "toPort" ] }, "aws:ec2/DefaultRouteTableRoute:DefaultRouteTableRoute": { "properties": { "cidrBlock": { "type": "string", "description": "The CIDR block of the route.\n" }, "coreNetworkArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of a core network.\n" }, "destinationPrefixListId": { "type": "string", "description": "The ID of a managed prefix list destination of the route.\n\nOne of the following target arguments must be supplied:\n" }, "egressOnlyGatewayId": { "type": "string", "description": "Identifier of a VPC Egress Only Internet Gateway.\n" }, "gatewayId": { "type": "string", "description": "Identifier of a VPC internet gateway or a virtual private gateway.\n" }, "instanceId": { "type": "string", "description": "Identifier of an EC2 instance.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The Ipv6 CIDR block of the route\n" }, "natGatewayId": { "type": "string", "description": "Identifier of a VPC NAT gateway.\n" }, "networkInterfaceId": { "type": "string", "description": "Identifier of an EC2 network interface.\n" }, "transitGatewayId": { "type": "string", "description": "Identifier of an EC2 Transit Gateway.\n" }, "vpcEndpointId": { "type": "string", "description": "Identifier of a VPC Endpoint. This route must be removed prior to VPC Endpoint deletion.\n" }, "vpcPeeringConnectionId": { "type": "string", "description": "Identifier of a VPC peering connection.\n\nNote that the default route, mapping the VPC's CIDR block to \"local\", is created implicitly and cannot be specified.\n" } }, "type": "object" }, "aws:ec2/DefaultSecurityGroupEgress:DefaultSecurityGroupEgress": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks.\n" }, "description": { "type": "string", "description": "Description of this rule.\n" }, "fromPort": { "type": "integer", "description": "Start port (or ICMP type number if protocol is `icmp`)\n" }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 CIDR blocks.\n" }, "prefixListIds": { "type": "array", "items": { "type": "string" }, "description": "List of prefix list IDs (for allowing access to VPC endpoints)\n" }, "protocol": { "type": "string", "description": "Protocol. If you select a protocol of \"-1\" (semantically equivalent to `all`, which is not a valid value here), you must specify a `from_port` and `to_port` equal to `0`. If not `icmp`, `tcp`, `udp`, or `-1` use the [protocol number](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.\n" }, "self": { "type": "boolean", "description": "Whether the security group itself will be added as a source to this egress rule.\n" }, "toPort": { "type": "integer", "description": "End range port (or ICMP code if protocol is `icmp`).\n" } }, "type": "object", "required": [ "fromPort", "protocol", "toPort" ] }, "aws:ec2/DefaultSecurityGroupIngress:DefaultSecurityGroupIngress": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks.\n" }, "description": { "type": "string", "description": "Description of the security group.\n" }, "fromPort": { "type": "integer", "description": "Start port (or ICMP type number if protocol is `icmp`)\n" }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 CIDR blocks.\n" }, "prefixListIds": { "type": "array", "items": { "type": "string" }, "description": "List of prefix list IDs (for allowing access to VPC endpoints)\n" }, "protocol": { "type": "string", "description": "Protocol. If you select a protocol of \"-1\" (semantically equivalent to `all`, which is not a valid value here), you must specify a `from_port` and `to_port` equal to `0`. If not `icmp`, `tcp`, `udp`, or `-1` use the [protocol number](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.\n" }, "self": { "type": "boolean", "description": "Whether the security group itself will be added as a source to this egress rule.\n" }, "toPort": { "type": "integer", "description": "End range port (or ICMP code if protocol is `icmp`).\n" } }, "type": "object", "required": [ "fromPort", "protocol", "toPort" ] }, "aws:ec2/EipDomainNameTimeouts:EipDomainNameTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2/FleetFleetInstanceSet:FleetFleetInstanceSet": { "properties": { "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the instances.\n" }, "instanceType": { "type": "string", "description": "The instance type.\n" }, "lifecycle": { "type": "string", "description": "Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.\n" }, "platform": { "type": "string", "description": "The value is `Windows` for Windows instances. Otherwise, the value is blank.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceIds", "instanceType", "lifecycle", "platform" ] } } }, "aws:ec2/FleetLaunchTemplateConfig:FleetLaunchTemplateConfig": { "properties": { "launchTemplateSpecification": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigLaunchTemplateSpecification:FleetLaunchTemplateConfigLaunchTemplateSpecification", "description": "Nested argument containing EC2 Launch Template to use. Defined below.\n" }, "overrides": { "type": "array", "items": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverride:FleetLaunchTemplateConfigOverride" }, "description": "Nested argument(s) containing parameters to override the same parameters in the Launch Template. Defined below.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigLaunchTemplateSpecification:FleetLaunchTemplateConfigLaunchTemplateSpecification": { "properties": { "launchTemplateId": { "type": "string", "description": "The ID of the launch template.\n" }, "launchTemplateName": { "type": "string", "description": "The name of the launch template.\n" }, "version": { "type": "string", "description": "The launch template version number, `$Latest`, or `$Default.`\n" } }, "type": "object", "required": [ "version" ] }, "aws:ec2/FleetLaunchTemplateConfigOverride:FleetLaunchTemplateConfigOverride": { "properties": { "availabilityZone": { "type": "string", "description": "Availability Zone in which to launch the instances.\n" }, "instanceRequirements": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirements:FleetLaunchTemplateConfigOverrideInstanceRequirements", "description": "Override the instance type in the Launch Template with instance types that satisfy the requirements.\n" }, "instanceType": { "type": "string", "description": "Instance type.\n" }, "maxPrice": { "type": "string", "description": "Maximum price per unit hour that you are willing to pay for a Spot Instance.\n" }, "priority": { "type": "number", "description": "Priority for the launch template override. If `on_demand_options` `allocation_strategy` is set to `prioritized`, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. Valid values are whole numbers starting at 0.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet in which to launch the instances.\n" }, "weightedCapacity": { "type": "number", "description": "Number of units provided by the specified instance type.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirements:FleetLaunchTemplateConfigOverrideInstanceRequirements": { "properties": { "acceleratorCount": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount", "description": "Block describing the minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips). Default is no minimum or maximum limits.\n" }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator manufacturer names. Default is any manufacturer.\n" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator names. Default is any acclerator.\n" }, "acceleratorTotalMemoryMib": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib:FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib", "description": "Block describing the minimum and maximum total memory of the accelerators. Default is no minimum or maximum.\n" }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "The accelerator types that must be on the instance type. Default is any accelerator type.\n" }, "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. You can use strings with one or more wild cards,represented by an asterisk (\\*). The following are examples: `c5*`, `m5a.*`, `r*`, `*3*`. 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.*`, you are excluding all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is no excluded instance types. Default is any instance type.\n\nIf you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.\n" }, "bareMetal": { "type": "string", "description": "Indicate whether bare metal instace types should be `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "baselineEbsBandwidthMbps": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps:FleetLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps", "description": "Block describing the minimum and maximum baseline EBS bandwidth, in Mbps. Default is no minimum or maximum.\n" }, "burstablePerformance": { "type": "string", "description": "Indicates whether burstable performance T instance types are `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "The CPU manufacturers to include. Default is any manufacturer.\n\u003e **NOTE:** 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" }, "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 (\\*). The following are examples: `c5*`, `m5a.*`, `r*`, `*3*`. 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.*`, you are excluding all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is no excluded instance types.\n\nIf you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.\n" }, "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. Valid values are `current` and `previous`. Default is `current` and `previous` generation instance types.\n" }, "localStorage": { "type": "string", "description": "Indicate whether instance types with local storage volumes are `included`, `excluded`, or `required`. Default is `included`.\n" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "List of local storage type names. Valid values are `hdd` and `ssd`. Default any storage type.\n" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Conflicts with `spot_max_price_percentage_over_lowest_price`\n" }, "memoryGibPerVcpu": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu:FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu", "description": "Block describing the minimum and maximum amount of memory (GiB) per vCPU. Default is no minimum or maximum.\n" }, "memoryMib": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib:FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib", "description": "The minimum and maximum amount of memory per vCPU, in GiB. Default is no minimum or maximum limits.\n" }, "networkBandwidthGbps": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps:FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps", "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default is No minimum or maximum.\n" }, "networkInterfaceCount": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount", "description": "Block describing the minimum and maximum number of network interfaces. Default is no minimum or maximum.\n" }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 20.\n\nIf you set `target_capacity_unit_type` 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" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicate whether instance types must support On-Demand Instance Hibernation, either `true` or `false`. Default is `false`.\n" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 100. Conflicts with `max_spot_price_as_percentage_of_optimal_on_demand_price`\n\nIf 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" }, "totalLocalStorageGb": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb:FleetLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb", "description": "Block describing the minimum and maximum total local storage (GB). Default is no minimum or maximum.\n" }, "vcpuCount": { "$ref": "#/types/aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount", "description": "Block describing the minimum and maximum number of vCPUs. Default is no maximum.\n" } }, "type": "object", "required": [ "memoryMib", "vcpuCount" ] }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount": { "properties": { "max": { "type": "integer", "description": "Maximum. Set to `0` to exclude instance types with accelerators.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib:FleetLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer", "description": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "integer", "description": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps:FleetLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps": { "properties": { "max": { "type": "integer", "description": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter..\n" }, "min": { "type": "integer", "description": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter..\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu:FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu": { "properties": { "max": { "type": "number", "description": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "number", "description": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib:FleetLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib": { "properties": { "max": { "type": "integer", "description": "The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "integer", "description": "The minimum amount of memory, in MiB. To specify no minimum limit, specify `0`.\n" } }, "type": "object", "required": [ "min" ] }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps:FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps": { "properties": { "max": { "type": "number", "description": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "number", "description": "The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount": { "properties": { "max": { "type": "integer", "description": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "integer", "description": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb:FleetLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb": { "properties": { "max": { "type": "number", "description": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "number", "description": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.\n" } }, "type": "object" }, "aws:ec2/FleetLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount:FleetLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount": { "properties": { "max": { "type": "integer", "description": "The maximum number of vCPUs. To specify no maximum limit, omit this parameter.\n" }, "min": { "type": "integer", "description": "The minimum number of vCPUs. To specify no minimum limit, specify `0`.\n" } }, "type": "object", "required": [ "min" ] }, "aws:ec2/FleetOnDemandOptions:FleetOnDemandOptions": { "properties": { "allocationStrategy": { "type": "string", "description": "The order of the launch template overrides to use in fulfilling On-Demand capacity. Valid values: `lowestPrice`, `prioritized`. Default: `lowestPrice`.\n", "willReplaceOnChanges": true }, "capacityReservationOptions": { "$ref": "#/types/aws:ec2/FleetOnDemandOptionsCapacityReservationOptions:FleetOnDemandOptionsCapacityReservationOptions", "description": "The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type `instant`.\n" }, "maxTotalPrice": { "type": "string", "description": "The maximum amount per hour for On-Demand Instances that you're willing to pay.\n" }, "minTargetCapacity": { "type": "integer", "description": "The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. Supported only for fleets of type `instant`.\nIf you specify `min_target_capacity`, at least one of the following must be specified: `single_availability_zone` or `single_instance_type`.\n" }, "singleAvailabilityZone": { "type": "boolean", "description": "Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type `instant`.\n" }, "singleInstanceType": { "type": "boolean", "description": "Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type `instant`.\n" } }, "type": "object" }, "aws:ec2/FleetOnDemandOptionsCapacityReservationOptions:FleetOnDemandOptionsCapacityReservationOptions": { "properties": { "usageStrategy": { "type": "string", "description": "Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity. Valid values: `use-capacity-reservations-first`.\n" } }, "type": "object" }, "aws:ec2/FleetSpotOptions:FleetSpotOptions": { "properties": { "allocationStrategy": { "type": "string", "description": "How to allocate the target capacity across the Spot pools. Valid values: `diversified`, `lowestPrice`, `capacity-optimized`, `capacity-optimized-prioritized` and `price-capacity-optimized`. Default: `lowestPrice`.\n", "willReplaceOnChanges": true }, "instanceInterruptionBehavior": { "type": "string", "description": "Behavior when a Spot Instance is interrupted. Valid values: `hibernate`, `stop`, `terminate`. Default: `terminate`.\n", "willReplaceOnChanges": true }, "instancePoolsToUseCount": { "type": "integer", "description": "Number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot `allocation_strategy` is set to `lowestPrice`. Default: `1`.\n", "willReplaceOnChanges": true }, "maintenanceStrategies": { "$ref": "#/types/aws:ec2/FleetSpotOptionsMaintenanceStrategies:FleetSpotOptionsMaintenanceStrategies", "description": "Nested argument containing maintenance strategies for managing your Spot Instances that are at an elevated risk of being interrupted. Defined below.\n" }, "maxTotalPrice": { "type": "string", "description": "The maximum amount per hour for Spot Instances that you're willing to pay.\n", "willReplaceOnChanges": true }, "minTargetCapacity": { "type": "integer", "description": "The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. Supported only for fleets of type `instant`.\n", "willReplaceOnChanges": true }, "singleAvailabilityZone": { "type": "boolean", "description": "Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type `instant`.\n", "willReplaceOnChanges": true }, "singleInstanceType": { "type": "boolean", "description": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type `instant`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/FleetSpotOptionsMaintenanceStrategies:FleetSpotOptionsMaintenanceStrategies": { "properties": { "capacityRebalance": { "$ref": "#/types/aws:ec2/FleetSpotOptionsMaintenanceStrategiesCapacityRebalance:FleetSpotOptionsMaintenanceStrategiesCapacityRebalance", "description": "Nested argument containing the capacity rebalance for your fleet request. Defined below.\n" } }, "type": "object" }, "aws:ec2/FleetSpotOptionsMaintenanceStrategiesCapacityRebalance:FleetSpotOptionsMaintenanceStrategiesCapacityRebalance": { "properties": { "replacementStrategy": { "type": "string", "description": "The replacement strategy to use. Only available for fleets of `type` set to `maintain`. Valid values: `launch`.\n", "willReplaceOnChanges": true }, "terminationDelay": { "type": "integer" } }, "type": "object" }, "aws:ec2/FleetTargetCapacitySpecification:FleetTargetCapacitySpecification": { "properties": { "defaultTargetCapacityType": { "type": "string", "description": "Default target capacity type. Valid values: `on-demand`, `spot`.\n", "willReplaceOnChanges": true }, "onDemandTargetCapacity": { "type": "integer", "description": "The number of On-Demand units to request.\n", "willReplaceOnChanges": true }, "spotTargetCapacity": { "type": "integer", "description": "The number of Spot units to request.\n", "willReplaceOnChanges": true }, "targetCapacityUnitType": { "type": "string", "description": "The unit for the target capacity.\nIf you specify `target_capacity_unit_type`, `instance_requirements` must be specified.\n", "willReplaceOnChanges": true }, "totalTargetCapacity": { "type": "integer", "description": "The number of units to request, filled using `default_target_capacity_type`.\n" } }, "type": "object", "required": [ "defaultTargetCapacityType", "totalTargetCapacity" ] }, "aws:ec2/FlowLogDestinationOptions:FlowLogDestinationOptions": { "properties": { "fileFormat": { "type": "string", "description": "The format for the flow log. Default value: `plain-text`. Valid values: `plain-text`, `parquet`.\n", "willReplaceOnChanges": true }, "hiveCompatiblePartitions": { "type": "boolean", "description": "Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. Default value: `false`.\n", "willReplaceOnChanges": true }, "perHourPartition": { "type": "boolean", "description": "Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. Default value: `false`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/InstanceCapacityReservationSpecification:InstanceCapacityReservationSpecification": { "properties": { "capacityReservationPreference": { "type": "string", "description": "Indicates the instance's Capacity Reservation preferences. Can be `\"open\"` or `\"none\"`. (Default: `\"open\"`).\n" }, "capacityReservationTarget": { "$ref": "#/types/aws:ec2/InstanceCapacityReservationSpecificationCapacityReservationTarget:InstanceCapacityReservationSpecificationCapacityReservationTarget", "description": "Information about the target Capacity Reservation. See Capacity Reservation Target below for more details.\n\nFor more information, see the documentation on [Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html).\n" } }, "type": "object" }, "aws:ec2/InstanceCapacityReservationSpecificationCapacityReservationTarget:InstanceCapacityReservationSpecificationCapacityReservationTarget": { "properties": { "capacityReservationId": { "type": "string", "description": "ID of the Capacity Reservation in which to run the instance.\n" }, "capacityReservationResourceGroupArn": { "type": "string", "description": "ARN of the Capacity Reservation resource group in which to run the instance.\n" } }, "type": "object" }, "aws:ec2/InstanceCpuOptions:InstanceCpuOptions": { "properties": { "amdSevSnp": { "type": "string", "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. Valid values are `enabled` and `disabled`.\n", "willReplaceOnChanges": true }, "coreCount": { "type": "integer", "description": "Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options [CPU Cores and Threads Per CPU Core Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#cpu-options-supported-instances-values) - specifying this option for unsupported instance types will return an error from the EC2 API.\n", "willReplaceOnChanges": true }, "threadsPerCore": { "type": "integer", "description": "If set to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) for more information.\n\nFor more information, see the documentation on [Optimizing CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amdSevSnp", "coreCount", "threadsPerCore" ] } } }, "aws:ec2/InstanceCreditSpecification:InstanceCreditSpecification": { "properties": { "cpuCredits": { "type": "string", "description": "Credit option for CPU usage. Valid values include `standard` or `unlimited`. T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.\n" } }, "type": "object" }, "aws:ec2/InstanceEbsBlockDevice:InstanceEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the volume should be destroyed on instance termination. Defaults to `true`.\n", "willReplaceOnChanges": true }, "deviceName": { "type": "string", "description": "Name of the device to mount.\n", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "description": "Enables [EBS encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) on the volume. Defaults to `false`. Cannot be used with `snapshot_id`. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Amount of provisioned [IOPS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html). Only valid for volume_type of `io1`, `io2` or `gp3`.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS Key to use when encrypting the volume. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "description": "Snapshot ID to mount.\n", "willReplaceOnChanges": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assign to the device.\n" }, "tagsAll": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.\n" }, "throughput": { "type": "integer", "description": "Throughput to provision for a volume in mebibytes per second (MiB/s). This is only valid for `volume_type` of `gp3`.\n", "willReplaceOnChanges": true }, "volumeId": { "type": "string", "description": "ID of the volume. For example, the ID can be accessed like this, `aws_instance.web.root_block_device.0.volume_id`.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "Type of volume. Valid values include `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1`, or `st1`. Defaults to `gp2`.\n\n\u003e **NOTE:** Currently, changes to the `ebs_block_device` configuration of _existing_ resources cannot be automatically detected by this provider. To manage changes and attachments of an EBS block to an instance, use the `aws.ebs.Volume` and `aws.ec2.VolumeAttachment` resources instead. If you use `ebs_block_device` on an `aws.ec2.Instance`, this provider will assume management over the full set of non-root EBS block devices for the instance, treating additional block devices as drift. For this reason, `ebs_block_device` cannot be mixed with external `aws.ebs.Volume` and `aws.ec2.VolumeAttachment` resources for a given instance.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "kmsKeyId", "snapshotId", "tagsAll", "throughput", "volumeId", "volumeSize", "volumeType" ] } } }, "aws:ec2/InstanceEnclaveOptions:InstanceEnclaveOptions": { "properties": { "enabled": { "type": "boolean", "description": "Whether Nitro Enclaves will be enabled on the instance. Defaults to `false`.\n\nFor more information, see the documentation on [Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:ec2/InstanceEphemeralBlockDevice:InstanceEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Name of the block device to mount on the instance.\n" }, "noDevice": { "type": "boolean", "description": "Suppresses the specified device included in the AMI's block device mapping.\n" }, "virtualName": { "type": "string", "description": "[Instance Store Device Name](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#InstanceStoreDeviceNames) (e.g., `ephemeral0`).\n\nEach AWS Instance type has a different set of Instance Store block devices available for attachment. AWS [publishes a list](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#StorageOnInstanceTypes) of which ephemeral devices are available on each type. The devices are always identified by the `virtual_name` in the format `ephemeral{0..N}`.\n" } }, "type": "object", "required": [ "deviceName" ] }, "aws:ec2/InstanceInstanceMarketOptions:InstanceInstanceMarketOptions": { "properties": { "marketType": { "type": "string", "description": "Type of market for the instance. Valid values are `spot` and `capacity-block`. Defaults to `spot`. Required if `spot_options` is specified.\n", "willReplaceOnChanges": true }, "spotOptions": { "$ref": "#/types/aws:ec2/InstanceInstanceMarketOptionsSpotOptions:InstanceInstanceMarketOptionsSpotOptions", "description": "Block to configure the options for Spot Instances. See Spot Options below for details on attributes.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "marketType", "spotOptions" ] } } }, "aws:ec2/InstanceInstanceMarketOptionsSpotOptions:InstanceInstanceMarketOptionsSpotOptions": { "properties": { "instanceInterruptionBehavior": { "type": "string", "description": "The behavior when a Spot Instance is interrupted. Valid values include `hibernate`, `stop`, `terminate` . The default is `terminate`.\n", "willReplaceOnChanges": true }, "maxPrice": { "type": "string", "description": "The maximum hourly price that you're willing to pay for a Spot Instance.\n", "willReplaceOnChanges": true }, "spotInstanceType": { "type": "string", "description": "The Spot Instance request type. Valid values include `one-time`, `persistent`. Persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop. The default is `one-time`.\n", "willReplaceOnChanges": true }, "validUntil": { "type": "string", "description": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceInterruptionBehavior", "maxPrice", "spotInstanceType", "validUntil" ] } } }, "aws:ec2/InstanceLaunchTemplate:InstanceLaunchTemplate": { "properties": { "id": { "type": "string", "description": "ID of the launch template. Conflicts with `name`.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the launch template. Conflicts with `id`.\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "Template version. Can be a specific version number, `$Latest` or `$Default`. The default value is `$Default`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "name" ] } } }, "aws:ec2/InstanceMaintenanceOptions:InstanceMaintenanceOptions": { "properties": { "autoRecovery": { "type": "string", "description": "Automatic recovery behavior of the Instance. Can be `\"default\"` or `\"disabled\"`. See [Recover your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html) for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRecovery" ] } } }, "aws:ec2/InstanceMetadataOptions:InstanceMetadataOptions": { "properties": { "httpEndpoint": { "type": "string", "description": "Whether the metadata service is available. Valid values include `enabled` or `disabled`. Defaults to `enabled`.\n" }, "httpProtocolIpv6": { "type": "string", "description": "Whether the IPv6 endpoint for the instance metadata service is enabled. Defaults to `disabled`.\n" }, "httpPutResponseHopLimit": { "type": "integer", "description": "Desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Valid values are integer from `1` to `64`. Defaults to `1`.\n" }, "httpTokens": { "type": "string", "description": "Whether or not the metadata service requires session tokens, also referred to as _Instance Metadata Service Version 2 (IMDSv2)_. Valid values include `optional` or `required`.\n" }, "instanceMetadataTags": { "type": "string", "description": "Enables or disables access to instance tags from the instance metadata service. Valid values include `enabled` or `disabled`. Defaults to `disabled`.\n\nFor more information, see the documentation on the [Instance Metadata Service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "httpPutResponseHopLimit", "httpTokens", "instanceMetadataTags" ] } } }, "aws:ec2/InstanceNetworkInterface:InstanceNetworkInterface": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether or not to delete the network interface on instance termination. Defaults to `false`. Currently, the only valid value is `false`, as this is only supported when creating new network interfaces when launching an instance.\n", "willReplaceOnChanges": true }, "deviceIndex": { "type": "integer", "description": "Integer index of the network interface attachment. Limited by instance type.\n", "willReplaceOnChanges": true }, "networkCardIndex": { "type": "integer", "description": "Integer index of the network card. Limited by instance type. The default index is `0`.\n", "willReplaceOnChanges": true }, "networkInterfaceId": { "type": "string", "description": "ID of the network interface to attach.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceIndex", "networkInterfaceId" ] }, "aws:ec2/InstancePlatform:InstancePlatform": { "type": "string", "enum": [ { "name": "LinuxUnix", "value": "Linux/UNIX" }, { "name": "RedHatEnterpriseLinux", "value": "Red Hat Enterprise Linux" }, { "name": "SuseLinux", "value": "SUSE Linux" }, { "name": "Windows", "value": "Windows" }, { "name": "WindowsWithSqlServer", "value": "Windows with SQL Server" }, { "name": "WindowsWithSqlServerEnterprise", "value": "Windows with SQL Server Enterprise" }, { "name": "WindowsWithSqlServerStandard", "value": "Windows with SQL Server Standard" }, { "name": "WindowsWithSqlServerWeb", "value": "Windows with SQL Server Web" } ] }, "aws:ec2/InstancePrivateDnsNameOptions:InstancePrivateDnsNameOptions": { "properties": { "enableResourceNameDnsARecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n" }, "enableResourceNameDnsAaaaRecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n" }, "hostnameType": { "type": "string", "description": "Type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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. Valid values: `ip-name` and `resource-name`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableResourceNameDnsARecord", "enableResourceNameDnsAaaaRecord", "hostnameType" ] } } }, "aws:ec2/InstanceRootBlockDevice:InstanceRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the volume should be destroyed on instance termination. Defaults to `true`.\n" }, "deviceName": { "type": "string", "description": "Device name, e.g., `/dev/sdh` or `xvdh`.\n" }, "encrypted": { "type": "boolean", "description": "Whether to enable volume encryption. Defaults to `false`. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Amount of provisioned [IOPS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html). Only valid for volume_type of `io1`, `io2` or `gp3`.\n" }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS Key to use when encrypting the volume. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assign to the device.\n" }, "tagsAll": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.\n" }, "throughput": { "type": "integer", "description": "Throughput to provision for a volume in mebibytes per second (MiB/s). This is only valid for `volume_type` of `gp3`.\n" }, "volumeId": { "type": "string", "description": "ID of the volume. For example, the ID can be accessed like this, `aws_instance.web.root_block_device.0.volume_id`.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume in gibibytes (GiB).\n" }, "volumeType": { "type": "string", "description": "Type of volume. Valid values include `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1`, or `st1`. Defaults to the volume type that the AMI uses.\n\nModifying the `encrypted` or `kms_key_id` settings of the `root_block_device` requires resource replacement.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "kmsKeyId", "tagsAll", "throughput", "volumeId", "volumeSize", "volumeType" ] } } }, "aws:ec2/InstanceType:InstanceType": { "type": "string", "enum": [ { "name": "A1_2XLarge", "value": "a1.2xlarge" }, { "name": "A1_4XLarge", "value": "a1.4xlarge" }, { "name": "A1_Large", "value": "a1.large" }, { "name": "A1_Medium", "value": "a1.medium" }, { "name": "A1_Metal", "value": "a1.metal" }, { "name": "A1_XLarge", "value": "a1.xlarge" }, { "name": "C1_Medium", "value": "c1.medium" }, { "name": "C1_XLarge", "value": "c1.xlarge" }, { "name": "C3_2XLarge", "value": "c3.2xlarge" }, { "name": "C3_4XLarge", "value": "c3.4xlarge" }, { "name": "C3_8XLarge", "value": "c3.8xlarge" }, { "name": "C3_Large", "value": "c3.large" }, { "name": "C3_XLarge", "value": "c3.xlarge" }, { "name": "C4_2XLarge", "value": "c4.2xlarge" }, { "name": "C4_4XLarge", "value": "c4.4xlarge" }, { "name": "C4_8XLarge", "value": "c4.8xlarge" }, { "name": "C4_Large", "value": "c4.large" }, { "name": "C4_XLarge", "value": "c4.xlarge" }, { "name": "C5_12XLarge", "value": "c5.12xlarge" }, { "name": "C5_18XLarge", "value": "c5.18xlarge" }, { "name": "C5_24XLarge", "value": "c5.24xlarge" }, { "name": "C5_2XLarge", "value": "c5.2xlarge" }, { "name": "C5_4XLarge", "value": "c5.4xlarge" }, { "name": "C5_9XLarge", "value": "c5.9xlarge" }, { "name": "C5_Large", "value": "c5.large" }, { "name": "C5_Metal", "value": "c5.metal" }, { "name": "C5_XLarge", "value": "c5.xlarge" }, { "name": "C5a_12XLarge", "value": "c5a.12xlarge" }, { "name": "C5a_16XLarge", "value": "c5a.16xlarge" }, { "name": "C5a_24XLarge", "value": "c5a.24xlarge" }, { "name": "C5a_2XLarge", "value": "c5a.2xlarge" }, { "name": "C5a_4XLarge", "value": "c5a.4xlarge" }, { "name": "C5a_8XLarge", "value": "c5a.8xlarge" }, { "name": "C5a_Large", "value": "c5a.large" }, { "name": "C5a_XLarge", "value": "c5a.xlarge" }, { "name": "C5ad_12XLarge", "value": "c5ad.12xlarge" }, { "name": "C5ad_16XLarge", "value": "c5ad.16xlarge" }, { "name": "C5ad_24XLarge", "value": "c5ad.24xlarge" }, { "name": "C5ad_2XLarge", "value": "c5ad.2xlarge" }, { "name": "C5ad_4XLarge", "value": "c5ad.4xlarge" }, { "name": "C5ad_8XLarge", "value": "c5ad.8xlarge" }, { "name": "C5ad_Large", "value": "c5ad.large" }, { "name": "C5ad_XLarge", "value": "c5ad.xlarge" }, { "name": "C5d_12XLarge", "value": "c5d.12xlarge" }, { "name": "C5d_18XLarge", "value": "c5d.18xlarge" }, { "name": "C5d_24XLarge", "value": "c5d.24xlarge" }, { "name": "C5d_2XLarge", "value": "c5d.2xlarge" }, { "name": "C5d_4XLarge", "value": "c5d.4xlarge" }, { "name": "C5d_9XLarge", "value": "c5d.9xlarge" }, { "name": "C5d_Large", "value": "c5d.large" }, { "name": "C5d_Metal", "value": "c5d.metal" }, { "name": "C5d_XLarge", "value": "c5d.xlarge" }, { "name": "C5n_18XLarge", "value": "c5n.18xlarge" }, { "name": "C5n_2XLarge", "value": "c5n.2xlarge" }, { "name": "C5n_4XLarge", "value": "c5n.4xlarge" }, { "name": "C5n_9XLarge", "value": "c5n.9xlarge" }, { "name": "C5n_Large", "value": "c5n.large" }, { "name": "C5n_Metal", "value": "c5n.metal" }, { "name": "C5n_XLarge", "value": "c5n.xlarge" }, { "name": "C6a_12XLarge", "value": "c6a.12xlarge" }, { "name": "C6a_16XLarge", "value": "c6a.16xlarge" }, { "name": "C6a_24XLarge", "value": "c6a.24xlarge" }, { "name": "C6a_2XLarge", "value": "c6a.2xlarge" }, { "name": "C6a_32XLarge", "value": "c6a.32xlarge" }, { "name": "C6a_48XLarge", "value": "c6a.48xlarge" }, { "name": "C6a_4XLarge", "value": "c6a.4xlarge" }, { "name": "C6a_8XLarge", "value": "c6a.8xlarge" }, { "name": "C6a_Large", "value": "c6a.large" }, { "name": "C6a_Metal", "value": "c6a.metal" }, { "name": "C6a_XLarge", "value": "c6a.xlarge" }, { "name": "C6g_12XLarge", "value": "c6g.12xlarge" }, { "name": "C6g_16XLarge", "value": "c6g.16xlarge" }, { "name": "C6g_2XLarge", "value": "c6g.2xlarge" }, { "name": "C6g_4XLarge", "value": "c6g.4xlarge" }, { "name": "C6g_8XLarge", "value": "c6g.8xlarge" }, { "name": "C6g_Large", "value": "c6g.large" }, { "name": "C6g_Medium", "value": "c6g.medium" }, { "name": "C6g_Metal", "value": "c6g.metal" }, { "name": "C6g_XLarge", "value": "c6g.xlarge" }, { "name": "C6gd_12XLarge", "value": "c6gd.12xlarge" }, { "name": "C6gd_16XLarge", "value": "c6gd.16xlarge" }, { "name": "C6gd_2XLarge", "value": "c6gd.2xlarge" }, { "name": "C6gd_4XLarge", "value": "c6gd.4xlarge" }, { "name": "C6gd_8XLarge", "value": "c6gd.8xlarge" }, { "name": "C6gd_Large", "value": "c6gd.large" }, { "name": "C6gd_Medium", "value": "c6gd.medium" }, { "name": "C6gd_Metal", "value": "c6gd.metal" }, { "name": "C6gd_XLarge", "value": "c6gd.xlarge" }, { "name": "C6gn_12XLarge", "value": "c6gn.12xlarge" }, { "name": "C6gn_16XLarge", "value": "c6gn.16xlarge" }, { "name": "C6gn_2XLarge", "value": "c6gn.2xlarge" }, { "name": "C6gn_4XLarge", "value": "c6gn.4xlarge" }, { "name": "C6gn_8XLarge", "value": "c6gn.8xlarge" }, { "name": "C6gn_Large", "value": "c6gn.large" }, { "name": "C6gn_Medium", "value": "c6gn.medium" }, { "name": "C6gn_XLarge", "value": "c6gn.xlarge" }, { "name": "C6i_12XLarge", "value": "c6i.12xlarge" }, { "name": "C6i_16XLarge", "value": "c6i.16xlarge" }, { "name": "C6i_24XLarge", "value": "c6i.24xlarge" }, { "name": "C6i_2XLarge", "value": "c6i.2xlarge" }, { "name": "C6i_32XLarge", "value": "c6i.32xlarge" }, { "name": "C6i_4XLarge", "value": "c6i.4xlarge" }, { "name": "C6i_8XLarge", "value": "c6i.8xlarge" }, { "name": "C6i_Large", "value": "c6i.large" }, { "name": "C6i_Metal", "value": "c6i.metal" }, { "name": "C6i_XLarge", "value": "c6i.xlarge" }, { "name": "C6id_12XLarge", "value": "c6id.12xlarge" }, { "name": "C6id_16XLarge", "value": "c6id.16xlarge" }, { "name": "C6id_24XLarge", "value": "c6id.24xlarge" }, { "name": "C6id_2XLarge", "value": "c6id.2xlarge" }, { "name": "C6id_32XLarge", "value": "c6id.32xlarge" }, { "name": "C6id_4XLarge", "value": "c6id.4xlarge" }, { "name": "C6id_8XLarge", "value": "c6id.8xlarge" }, { "name": "C6id_Large", "value": "c6id.large" }, { "name": "C6id_Metal", "value": "c6id.metal" }, { "name": "C6id_XLarge", "value": "c6id.xlarge" }, { "name": "C6in_12XLarge", "value": "c6in.12xlarge" }, { "name": "C6in_16XLarge", "value": "c6in.16xlarge" }, { "name": "C6in_24XLarge", "value": "c6in.24xlarge" }, { "name": "C6in_2XLarge", "value": "c6in.2xlarge" }, { "name": "C6in_32XLarge", "value": "c6in.32xlarge" }, { "name": "C6in_4XLarge", "value": "c6in.4xlarge" }, { "name": "C6in_8XLarge", "value": "c6in.8xlarge" }, { "name": "C6in_Large", "value": "c6in.large" }, { "name": "C6in_Metal", "value": "c6in.metal" }, { "name": "C6in_XLarge", "value": "c6in.xlarge" }, { "name": "C7a_12XLarge", "value": "c7a.12xlarge" }, { "name": "C7a_16XLarge", "value": "c7a.16xlarge" }, { "name": "C7a_24XLarge", "value": "c7a.24xlarge" }, { "name": "C7a_2XLarge", "value": "c7a.2xlarge" }, { "name": "C7a_32XLarge", "value": "c7a.32xlarge" }, { "name": "C7a_48XLarge", "value": "c7a.48xlarge" }, { "name": "C7a_4XLarge", "value": "c7a.4xlarge" }, { "name": "C7a_8XLarge", "value": "c7a.8xlarge" }, { "name": "C7a_Large", "value": "c7a.large" }, { "name": "C7a_Medium", "value": "c7a.medium" }, { "name": "C7a_Metal_48xl", "value": "c7a.metal-48xl" }, { "name": "C7a_XLarge", "value": "c7a.xlarge" }, { "name": "C7g_12XLarge", "value": "c7g.12xlarge" }, { "name": "C7g_16XLarge", "value": "c7g.16xlarge" }, { "name": "C7g_2XLarge", "value": "c7g.2xlarge" }, { "name": "C7g_4XLarge", "value": "c7g.4xlarge" }, { "name": "C7g_8XLarge", "value": "c7g.8xlarge" }, { "name": "C7g_Large", "value": "c7g.large" }, { "name": "C7g_Medium", "value": "c7g.medium" }, { "name": "C7g_Metal", "value": "c7g.metal" }, { "name": "C7g_XLarge", "value": "c7g.xlarge" }, { "name": "C7gd_12XLarge", "value": "c7gd.12xlarge" }, { "name": "C7gd_16XLarge", "value": "c7gd.16xlarge" }, { "name": "C7gd_2XLarge", "value": "c7gd.2xlarge" }, { "name": "C7gd_4XLarge", "value": "c7gd.4xlarge" }, { "name": "C7gd_8XLarge", "value": "c7gd.8xlarge" }, { "name": "C7gd_Large", "value": "c7gd.large" }, { "name": "C7gd_Medium", "value": "c7gd.medium" }, { "name": "C7gd_Metal", "value": "c7gd.metal" }, { "name": "C7gd_XLarge", "value": "c7gd.xlarge" }, { "name": "C7gn_12XLarge", "value": "c7gn.12xlarge" }, { "name": "C7gn_16XLarge", "value": "c7gn.16xlarge" }, { "name": "C7gn_2XLarge", "value": "c7gn.2xlarge" }, { "name": "C7gn_4XLarge", "value": "c7gn.4xlarge" }, { "name": "C7gn_8XLarge", "value": "c7gn.8xlarge" }, { "name": "C7gn_Large", "value": "c7gn.large" }, { "name": "C7gn_Medium", "value": "c7gn.medium" }, { "name": "C7gn_Metal", "value": "c7gn.metal" }, { "name": "C7gn_XLarge", "value": "c7gn.xlarge" }, { "name": "C7i_12XLarge", "value": "c7i.12xlarge" }, { "name": "C7i_16XLarge", "value": "c7i.16xlarge" }, { "name": "C7i_24XLarge", "value": "c7i.24xlarge" }, { "name": "C7i_2XLarge", "value": "c7i.2xlarge" }, { "name": "C7i_48XLarge", "value": "c7i.48xlarge" }, { "name": "C7i_4XLarge", "value": "c7i.4xlarge" }, { "name": "C7i_8XLarge", "value": "c7i.8xlarge" }, { "name": "C7i_Large", "value": "c7i.large" }, { "name": "C7i_Metal_24xl", "value": "c7i.metal-24xl" }, { "name": "C7i_Metal_48xl", "value": "c7i.metal-48xl" }, { "name": "C7i_XLarge", "value": "c7i.xlarge" }, { "name": "D2_2XLarge", "value": "d2.2xlarge" }, { "name": "D2_4XLarge", "value": "d2.4xlarge" }, { "name": "D2_8XLarge", "value": "d2.8xlarge" }, { "name": "D2_XLarge", "value": "d2.xlarge" }, { "name": "D3_2XLarge", "value": "d3.2xlarge" }, { "name": "D3_4XLarge", "value": "d3.4xlarge" }, { "name": "D3_8XLarge", "value": "d3.8xlarge" }, { "name": "D3_XLarge", "value": "d3.xlarge" }, { "name": "D3en_12XLarge", "value": "d3en.12xlarge" }, { "name": "D3en_2XLarge", "value": "d3en.2xlarge" }, { "name": "D3en_4XLarge", "value": "d3en.4xlarge" }, { "name": "D3en_6XLarge", "value": "d3en.6xlarge" }, { "name": "D3en_8XLarge", "value": "d3en.8xlarge" }, { "name": "D3en_XLarge", "value": "d3en.xlarge" }, { "name": "Dl1_24XLarge", "value": "dl1.24xlarge" }, { "name": "Dl2q_24XLarge", "value": "dl2q.24xlarge" }, { "name": "F1_16XLarge", "value": "f1.16xlarge" }, { "name": "F1_2XLarge", "value": "f1.2xlarge" }, { "name": "F1_4XLarge", "value": "f1.4xlarge" }, { "name": "G3_16XLarge", "value": "g3.16xlarge" }, { "name": "G3_4XLarge", "value": "g3.4xlarge" }, { "name": "G3_8XLarge", "value": "g3.8xlarge" }, { "name": "G3s_XLarge", "value": "g3s.xlarge" }, { "name": "G4ad_16XLarge", "value": "g4ad.16xlarge" }, { "name": "G4ad_2XLarge", "value": "g4ad.2xlarge" }, { "name": "G4ad_4XLarge", "value": "g4ad.4xlarge" }, { "name": "G4ad_8XLarge", "value": "g4ad.8xlarge" }, { "name": "G4ad_XLarge", "value": "g4ad.xlarge" }, { "name": "G4dn_12XLarge", "value": "g4dn.12xlarge" }, { "name": "G4dn_16XLarge", "value": "g4dn.16xlarge" }, { "name": "G4dn_2XLarge", "value": "g4dn.2xlarge" }, { "name": "G4dn_4XLarge", "value": "g4dn.4xlarge" }, { "name": "G4dn_8XLarge", "value": "g4dn.8xlarge" }, { "name": "G4dn_Metal", "value": "g4dn.metal" }, { "name": "G4dn_XLarge", "value": "g4dn.xlarge" }, { "name": "G5_12XLarge", "value": "g5.12xlarge" }, { "name": "G5_16XLarge", "value": "g5.16xlarge" }, { "name": "G5_24XLarge", "value": "g5.24xlarge" }, { "name": "G5_2XLarge", "value": "g5.2xlarge" }, { "name": "G5_48XLarge", "value": "g5.48xlarge" }, { "name": "G5_4XLarge", "value": "g5.4xlarge" }, { "name": "G5_8XLarge", "value": "g5.8xlarge" }, { "name": "G5_XLarge", "value": "g5.xlarge" }, { "name": "G5g_16XLarge", "value": "g5g.16xlarge" }, { "name": "G5g_2XLarge", "value": "g5g.2xlarge" }, { "name": "G5g_4XLarge", "value": "g5g.4xlarge" }, { "name": "G5g_8XLarge", "value": "g5g.8xlarge" }, { "name": "G5g_Metal", "value": "g5g.metal" }, { "name": "G5g_XLarge", "value": "g5g.xlarge" }, { "name": "G6_12XLarge", "value": "g6.12xlarge" }, { "name": "G6_16XLarge", "value": "g6.16xlarge" }, { "name": "G6_24XLarge", "value": "g6.24xlarge" }, { "name": "G6_2XLarge", "value": "g6.2xlarge" }, { "name": "G6_48XLarge", "value": "g6.48xlarge" }, { "name": "G6_4XLarge", "value": "g6.4xlarge" }, { "name": "G6_8XLarge", "value": "g6.8xlarge" }, { "name": "G6_XLarge", "value": "g6.xlarge" }, { "name": "Gr6_4XLarge", "value": "gr6.4xlarge" }, { "name": "Gr6_8XLarge", "value": "gr6.8xlarge" }, { "name": "H1_16XLarge", "value": "h1.16xlarge" }, { "name": "H1_2XLarge", "value": "h1.2xlarge" }, { "name": "H1_4XLarge", "value": "h1.4xlarge" }, { "name": "H1_8XLarge", "value": "h1.8xlarge" }, { "name": "I2_2XLarge", "value": "i2.2xlarge" }, { "name": "I2_4XLarge", "value": "i2.4xlarge" }, { "name": "I2_8XLarge", "value": "i2.8xlarge" }, { "name": "I2_XLarge", "value": "i2.xlarge" }, { "name": "I3_16XLarge", "value": "i3.16xlarge" }, { "name": "I3_2XLarge", "value": "i3.2xlarge" }, { "name": "I3_4XLarge", "value": "i3.4xlarge" }, { "name": "I3_8XLarge", "value": "i3.8xlarge" }, { "name": "I3_Large", "value": "i3.large" }, { "name": "I3_Metal", "value": "i3.metal" }, { "name": "I3_XLarge", "value": "i3.xlarge" }, { "name": "I3en_12XLarge", "value": "i3en.12xlarge" }, { "name": "I3en_24XLarge", "value": "i3en.24xlarge" }, { "name": "I3en_2XLarge", "value": "i3en.2xlarge" }, { "name": "I3en_3XLarge", "value": "i3en.3xlarge" }, { "name": "I3en_6XLarge", "value": "i3en.6xlarge" }, { "name": "I3en_Large", "value": "i3en.large" }, { "name": "I3en_Metal", "value": "i3en.metal" }, { "name": "I3en_XLarge", "value": "i3en.xlarge" }, { "name": "I4g_16XLarge", "value": "i4g.16xlarge" }, { "name": "I4g_2XLarge", "value": "i4g.2xlarge" }, { "name": "I4g_4XLarge", "value": "i4g.4xlarge" }, { "name": "I4g_8XLarge", "value": "i4g.8xlarge" }, { "name": "I4g_Large", "value": "i4g.large" }, { "name": "I4g_XLarge", "value": "i4g.xlarge" }, { "name": "I4i_12XLarge", "value": "i4i.12xlarge" }, { "name": "I4i_16XLarge", "value": "i4i.16xlarge" }, { "name": "I4i_24XLarge", "value": "i4i.24xlarge" }, { "name": "I4i_2XLarge", "value": "i4i.2xlarge" }, { "name": "I4i_32XLarge", "value": "i4i.32xlarge" }, { "name": "I4i_4XLarge", "value": "i4i.4xlarge" }, { "name": "I4i_8XLarge", "value": "i4i.8xlarge" }, { "name": "I4i_Large", "value": "i4i.large" }, { "name": "I4i_Metal", "value": "i4i.metal" }, { "name": "I4i_XLarge", "value": "i4i.xlarge" }, { "name": "Im4gn_16XLarge", "value": "im4gn.16xlarge" }, { "name": "Im4gn_2XLarge", "value": "im4gn.2xlarge" }, { "name": "Im4gn_4XLarge", "value": "im4gn.4xlarge" }, { "name": "Im4gn_8XLarge", "value": "im4gn.8xlarge" }, { "name": "Im4gn_Large", "value": "im4gn.large" }, { "name": "Im4gn_XLarge", "value": "im4gn.xlarge" }, { "name": "Inf1_24XLarge", "value": "inf1.24xlarge" }, { "name": "Inf1_2XLarge", "value": "inf1.2xlarge" }, { "name": "Inf1_6XLarge", "value": "inf1.6xlarge" }, { "name": "Inf1_XLarge", "value": "inf1.xlarge" }, { "name": "Inf2_24XLarge", "value": "inf2.24xlarge" }, { "name": "Inf2_48XLarge", "value": "inf2.48xlarge" }, { "name": "Inf2_8XLarge", "value": "inf2.8xlarge" }, { "name": "Inf2_XLarge", "value": "inf2.xlarge" }, { "name": "Is4gen_2XLarge", "value": "is4gen.2xlarge" }, { "name": "Is4gen_4XLarge", "value": "is4gen.4xlarge" }, { "name": "Is4gen_8XLarge", "value": "is4gen.8xlarge" }, { "name": "Is4gen_Large", "value": "is4gen.large" }, { "name": "Is4gen_Medium", "value": "is4gen.medium" }, { "name": "Is4gen_XLarge", "value": "is4gen.xlarge" }, { "name": "M1_Large", "value": "m1.large" }, { "name": "M1_Medium", "value": "m1.medium" }, { "name": "M1_Small", "value": "m1.small" }, { "name": "M1_XLarge", "value": "m1.xlarge" }, { "name": "M2_2XLarge", "value": "m2.2xlarge" }, { "name": "M2_4XLarge", "value": "m2.4xlarge" }, { "name": "M2_XLarge", "value": "m2.xlarge" }, { "name": "M3_2XLarge", "value": "m3.2xlarge" }, { "name": "M3_Large", "value": "m3.large" }, { "name": "M3_Medium", "value": "m3.medium" }, { "name": "M3_XLarge", "value": "m3.xlarge" }, { "name": "M4_10XLarge", "value": "m4.10xlarge" }, { "name": "M4_16XLarge", "value": "m4.16xlarge" }, { "name": "M4_2XLarge", "value": "m4.2xlarge" }, { "name": "M4_4XLarge", "value": "m4.4xlarge" }, { "name": "M4_Large", "value": "m4.large" }, { "name": "M4_XLarge", "value": "m4.xlarge" }, { "name": "M5_12XLarge", "value": "m5.12xlarge" }, { "name": "M5_16XLarge", "value": "m5.16xlarge" }, { "name": "M5_24XLarge", "value": "m5.24xlarge" }, { "name": "M5_2XLarge", "value": "m5.2xlarge" }, { "name": "M5_4XLarge", "value": "m5.4xlarge" }, { "name": "M5_8XLarge", "value": "m5.8xlarge" }, { "name": "M5_Large", "value": "m5.large" }, { "name": "M5_Metal", "value": "m5.metal" }, { "name": "M5_XLarge", "value": "m5.xlarge" }, { "name": "M5a_12XLarge", "value": "m5a.12xlarge" }, { "name": "M5a_16XLarge", "value": "m5a.16xlarge" }, { "name": "M5a_24XLarge", "value": "m5a.24xlarge" }, { "name": "M5a_2XLarge", "value": "m5a.2xlarge" }, { "name": "M5a_4XLarge", "value": "m5a.4xlarge" }, { "name": "M5a_8XLarge", "value": "m5a.8xlarge" }, { "name": "M5a_Large", "value": "m5a.large" }, { "name": "M5a_XLarge", "value": "m5a.xlarge" }, { "name": "M5ad_12XLarge", "value": "m5ad.12xlarge" }, { "name": "M5ad_16XLarge", "value": "m5ad.16xlarge" }, { "name": "M5ad_24XLarge", "value": "m5ad.24xlarge" }, { "name": "M5ad_2XLarge", "value": "m5ad.2xlarge" }, { "name": "M5ad_4XLarge", "value": "m5ad.4xlarge" }, { "name": "M5ad_8XLarge", "value": "m5ad.8xlarge" }, { "name": "M5ad_Large", "value": "m5ad.large" }, { "name": "M5ad_XLarge", "value": "m5ad.xlarge" }, { "name": "M5d_12XLarge", "value": "m5d.12xlarge" }, { "name": "M5d_16XLarge", "value": "m5d.16xlarge" }, { "name": "M5d_24XLarge", "value": "m5d.24xlarge" }, { "name": "M5d_2XLarge", "value": "m5d.2xlarge" }, { "name": "M5d_4XLarge", "value": "m5d.4xlarge" }, { "name": "M5d_8XLarge", "value": "m5d.8xlarge" }, { "name": "M5d_Large", "value": "m5d.large" }, { "name": "M5d_Metal", "value": "m5d.metal" }, { "name": "M5d_XLarge", "value": "m5d.xlarge" }, { "name": "M5dn_12XLarge", "value": "m5dn.12xlarge" }, { "name": "M5dn_16XLarge", "value": "m5dn.16xlarge" }, { "name": "M5dn_24XLarge", "value": "m5dn.24xlarge" }, { "name": "M5dn_2XLarge", "value": "m5dn.2xlarge" }, { "name": "M5dn_4XLarge", "value": "m5dn.4xlarge" }, { "name": "M5dn_8XLarge", "value": "m5dn.8xlarge" }, { "name": "M5dn_Large", "value": "m5dn.large" }, { "name": "M5dn_Metal", "value": "m5dn.metal" }, { "name": "M5dn_XLarge", "value": "m5dn.xlarge" }, { "name": "M5n_12XLarge", "value": "m5n.12xlarge" }, { "name": "M5n_16XLarge", "value": "m5n.16xlarge" }, { "name": "M5n_24XLarge", "value": "m5n.24xlarge" }, { "name": "M5n_2XLarge", "value": "m5n.2xlarge" }, { "name": "M5n_4XLarge", "value": "m5n.4xlarge" }, { "name": "M5n_8XLarge", "value": "m5n.8xlarge" }, { "name": "M5n_Large", "value": "m5n.large" }, { "name": "M5n_Metal", "value": "m5n.metal" }, { "name": "M5n_XLarge", "value": "m5n.xlarge" }, { "name": "M5zn_12XLarge", "value": "m5zn.12xlarge" }, { "name": "M5zn_2XLarge", "value": "m5zn.2xlarge" }, { "name": "M5zn_3XLarge", "value": "m5zn.3xlarge" }, { "name": "M5zn_6XLarge", "value": "m5zn.6xlarge" }, { "name": "M5zn_Large", "value": "m5zn.large" }, { "name": "M5zn_Metal", "value": "m5zn.metal" }, { "name": "M5zn_XLarge", "value": "m5zn.xlarge" }, { "name": "M6a_12XLarge", "value": "m6a.12xlarge" }, { "name": "M6a_16XLarge", "value": "m6a.16xlarge" }, { "name": "M6a_24XLarge", "value": "m6a.24xlarge" }, { "name": "M6a_2XLarge", "value": "m6a.2xlarge" }, { "name": "M6a_32XLarge", "value": "m6a.32xlarge" }, { "name": "M6a_48XLarge", "value": "m6a.48xlarge" }, { "name": "M6a_4XLarge", "value": "m6a.4xlarge" }, { "name": "M6a_8XLarge", "value": "m6a.8xlarge" }, { "name": "M6a_Large", "value": "m6a.large" }, { "name": "M6a_Metal", "value": "m6a.metal" }, { "name": "M6a_XLarge", "value": "m6a.xlarge" }, { "name": "M6g_12XLarge", "value": "m6g.12xlarge" }, { "name": "M6g_16XLarge", "value": "m6g.16xlarge" }, { "name": "M6g_2XLarge", "value": "m6g.2xlarge" }, { "name": "M6g_4XLarge", "value": "m6g.4xlarge" }, { "name": "M6g_8XLarge", "value": "m6g.8xlarge" }, { "name": "M6g_Large", "value": "m6g.large" }, { "name": "M6g_Medium", "value": "m6g.medium" }, { "name": "M6g_Metal", "value": "m6g.metal" }, { "name": "M6g_XLarge", "value": "m6g.xlarge" }, { "name": "M6gd_12XLarge", "value": "m6gd.12xlarge" }, { "name": "M6gd_16XLarge", "value": "m6gd.16xlarge" }, { "name": "M6gd_2XLarge", "value": "m6gd.2xlarge" }, { "name": "M6gd_4XLarge", "value": "m6gd.4xlarge" }, { "name": "M6gd_8XLarge", "value": "m6gd.8xlarge" }, { "name": "M6gd_Large", "value": "m6gd.large" }, { "name": "M6gd_Medium", "value": "m6gd.medium" }, { "name": "M6gd_Metal", "value": "m6gd.metal" }, { "name": "M6gd_XLarge", "value": "m6gd.xlarge" }, { "name": "M6i_12XLarge", "value": "m6i.12xlarge" }, { "name": "M6i_16XLarge", "value": "m6i.16xlarge" }, { "name": "M6i_24XLarge", "value": "m6i.24xlarge" }, { "name": "M6i_2XLarge", "value": "m6i.2xlarge" }, { "name": "M6i_32XLarge", "value": "m6i.32xlarge" }, { "name": "M6i_4XLarge", "value": "m6i.4xlarge" }, { "name": "M6i_8XLarge", "value": "m6i.8xlarge" }, { "name": "M6i_Large", "value": "m6i.large" }, { "name": "M6i_Metal", "value": "m6i.metal" }, { "name": "M6i_XLarge", "value": "m6i.xlarge" }, { "name": "M6id_12XLarge", "value": "m6id.12xlarge" }, { "name": "M6id_16XLarge", "value": "m6id.16xlarge" }, { "name": "M6id_24XLarge", "value": "m6id.24xlarge" }, { "name": "M6id_2XLarge", "value": "m6id.2xlarge" }, { "name": "M6id_32XLarge", "value": "m6id.32xlarge" }, { "name": "M6id_4XLarge", "value": "m6id.4xlarge" }, { "name": "M6id_8XLarge", "value": "m6id.8xlarge" }, { "name": "M6id_Large", "value": "m6id.large" }, { "name": "M6id_Metal", "value": "m6id.metal" }, { "name": "M6id_XLarge", "value": "m6id.xlarge" }, { "name": "M6idn_12XLarge", "value": "m6idn.12xlarge" }, { "name": "M6idn_16XLarge", "value": "m6idn.16xlarge" }, { "name": "M6idn_24XLarge", "value": "m6idn.24xlarge" }, { "name": "M6idn_2XLarge", "value": "m6idn.2xlarge" }, { "name": "M6idn_32XLarge", "value": "m6idn.32xlarge" }, { "name": "M6idn_4XLarge", "value": "m6idn.4xlarge" }, { "name": "M6idn_8XLarge", "value": "m6idn.8xlarge" }, { "name": "M6idn_Large", "value": "m6idn.large" }, { "name": "M6idn_Metal", "value": "m6idn.metal" }, { "name": "M6idn_XLarge", "value": "m6idn.xlarge" }, { "name": "M6in_12XLarge", "value": "m6in.12xlarge" }, { "name": "M6in_16XLarge", "value": "m6in.16xlarge" }, { "name": "M6in_24XLarge", "value": "m6in.24xlarge" }, { "name": "M6in_2XLarge", "value": "m6in.2xlarge" }, { "name": "M6in_32XLarge", "value": "m6in.32xlarge" }, { "name": "M6in_4XLarge", "value": "m6in.4xlarge" }, { "name": "M6in_8XLarge", "value": "m6in.8xlarge" }, { "name": "M6in_Large", "value": "m6in.large" }, { "name": "M6in_Metal", "value": "m6in.metal" }, { "name": "M6in_XLarge", "value": "m6in.xlarge" }, { "name": "M7a_12XLarge", "value": "m7a.12xlarge" }, { "name": "M7a_16XLarge", "value": "m7a.16xlarge" }, { "name": "M7a_24XLarge", "value": "m7a.24xlarge" }, { "name": "M7a_2XLarge", "value": "m7a.2xlarge" }, { "name": "M7a_32XLarge", "value": "m7a.32xlarge" }, { "name": "M7a_48XLarge", "value": "m7a.48xlarge" }, { "name": "M7a_4XLarge", "value": "m7a.4xlarge" }, { "name": "M7a_8XLarge", "value": "m7a.8xlarge" }, { "name": "M7a_Large", "value": "m7a.large" }, { "name": "M7a_Medium", "value": "m7a.medium" }, { "name": "M7a_Metal_48xl", "value": "m7a.metal-48xl" }, { "name": "M7a_XLarge", "value": "m7a.xlarge" }, { "name": "M7g_12XLarge", "value": "m7g.12xlarge" }, { "name": "M7g_16XLarge", "value": "m7g.16xlarge" }, { "name": "M7g_2XLarge", "value": "m7g.2xlarge" }, { "name": "M7g_4XLarge", "value": "m7g.4xlarge" }, { "name": "M7g_8XLarge", "value": "m7g.8xlarge" }, { "name": "M7g_Large", "value": "m7g.large" }, { "name": "M7g_Medium", "value": "m7g.medium" }, { "name": "M7g_Metal", "value": "m7g.metal" }, { "name": "M7g_XLarge", "value": "m7g.xlarge" }, { "name": "M7gd_12XLarge", "value": "m7gd.12xlarge" }, { "name": "M7gd_16XLarge", "value": "m7gd.16xlarge" }, { "name": "M7gd_2XLarge", "value": "m7gd.2xlarge" }, { "name": "M7gd_4XLarge", "value": "m7gd.4xlarge" }, { "name": "M7gd_8XLarge", "value": "m7gd.8xlarge" }, { "name": "M7gd_Large", "value": "m7gd.large" }, { "name": "M7gd_Medium", "value": "m7gd.medium" }, { "name": "M7gd_Metal", "value": "m7gd.metal" }, { "name": "M7gd_XLarge", "value": "m7gd.xlarge" }, { "name": "M7i_flex_2XLarge", "value": "m7i-flex.2xlarge" }, { "name": "M7i_flex_4XLarge", "value": "m7i-flex.4xlarge" }, { "name": "M7i_flex_8XLarge", "value": "m7i-flex.8xlarge" }, { "name": "M7i_flex_Large", "value": "m7i-flex.large" }, { "name": "M7i_flex_XLarge", "value": "m7i-flex.xlarge" }, { "name": "M7i_12XLarge", "value": "m7i.12xlarge" }, { "name": "M7i_16XLarge", "value": "m7i.16xlarge" }, { "name": "M7i_24XLarge", "value": "m7i.24xlarge" }, { "name": "M7i_2XLarge", "value": "m7i.2xlarge" }, { "name": "M7i_48XLarge", "value": "m7i.48xlarge" }, { "name": "M7i_4XLarge", "value": "m7i.4xlarge" }, { "name": "M7i_8XLarge", "value": "m7i.8xlarge" }, { "name": "M7i_Large", "value": "m7i.large" }, { "name": "M7i_Metal_24xl", "value": "m7i.metal-24xl" }, { "name": "M7i_Metal_48xl", "value": "m7i.metal-48xl" }, { "name": "M7i_XLarge", "value": "m7i.xlarge" }, { "name": "Mac1_Metal", "value": "mac1.metal" }, { "name": "Mac2_m2_Metal", "value": "mac2-m2.metal" }, { "name": "Mac2_m2pro_Metal", "value": "mac2-m2pro.metal" }, { "name": "Mac2_Metal", "value": "mac2.metal" }, { "name": "P2_16XLarge", "value": "p2.16xlarge" }, { "name": "P2_8XLarge", "value": "p2.8xlarge" }, { "name": "P2_XLarge", "value": "p2.xlarge" }, { "name": "P3_16XLarge", "value": "p3.16xlarge" }, { "name": "P3_2XLarge", "value": "p3.2xlarge" }, { "name": "P3_8XLarge", "value": "p3.8xlarge" }, { "name": "P3dn_24XLarge", "value": "p3dn.24xlarge" }, { "name": "P4d_24XLarge", "value": "p4d.24xlarge" }, { "name": "P5_48XLarge", "value": "p5.48xlarge" }, { "name": "R3_2XLarge", "value": "r3.2xlarge" }, { "name": "R3_4XLarge", "value": "r3.4xlarge" }, { "name": "R3_8XLarge", "value": "r3.8xlarge" }, { "name": "R3_Large", "value": "r3.large" }, { "name": "R3_XLarge", "value": "r3.xlarge" }, { "name": "R4_16XLarge", "value": "r4.16xlarge" }, { "name": "R4_2XLarge", "value": "r4.2xlarge" }, { "name": "R4_4XLarge", "value": "r4.4xlarge" }, { "name": "R4_8XLarge", "value": "r4.8xlarge" }, { "name": "R4_Large", "value": "r4.large" }, { "name": "R4_XLarge", "value": "r4.xlarge" }, { "name": "R5_12XLarge", "value": "r5.12xlarge" }, { "name": "R5_16XLarge", "value": "r5.16xlarge" }, { "name": "R5_24XLarge", "value": "r5.24xlarge" }, { "name": "R5_2XLarge", "value": "r5.2xlarge" }, { "name": "R5_4XLarge", "value": "r5.4xlarge" }, { "name": "R5_8XLarge", "value": "r5.8xlarge" }, { "name": "R5_Large", "value": "r5.large" }, { "name": "R5_Metal", "value": "r5.metal" }, { "name": "R5_XLarge", "value": "r5.xlarge" }, { "name": "R5a_12XLarge", "value": "r5a.12xlarge" }, { "name": "R5a_16XLarge", "value": "r5a.16xlarge" }, { "name": "R5a_24XLarge", "value": "r5a.24xlarge" }, { "name": "R5a_2XLarge", "value": "r5a.2xlarge" }, { "name": "R5a_4XLarge", "value": "r5a.4xlarge" }, { "name": "R5a_8XLarge", "value": "r5a.8xlarge" }, { "name": "R5a_Large", "value": "r5a.large" }, { "name": "R5a_XLarge", "value": "r5a.xlarge" }, { "name": "R5ad_12XLarge", "value": "r5ad.12xlarge" }, { "name": "R5ad_16XLarge", "value": "r5ad.16xlarge" }, { "name": "R5ad_24XLarge", "value": "r5ad.24xlarge" }, { "name": "R5ad_2XLarge", "value": "r5ad.2xlarge" }, { "name": "R5ad_4XLarge", "value": "r5ad.4xlarge" }, { "name": "R5ad_8XLarge", "value": "r5ad.8xlarge" }, { "name": "R5ad_Large", "value": "r5ad.large" }, { "name": "R5ad_XLarge", "value": "r5ad.xlarge" }, { "name": "R5b_12XLarge", "value": "r5b.12xlarge" }, { "name": "R5b_16XLarge", "value": "r5b.16xlarge" }, { "name": "R5b_24XLarge", "value": "r5b.24xlarge" }, { "name": "R5b_2XLarge", "value": "r5b.2xlarge" }, { "name": "R5b_4XLarge", "value": "r5b.4xlarge" }, { "name": "R5b_8XLarge", "value": "r5b.8xlarge" }, { "name": "R5b_Large", "value": "r5b.large" }, { "name": "R5b_Metal", "value": "r5b.metal" }, { "name": "R5b_XLarge", "value": "r5b.xlarge" }, { "name": "R5d_12XLarge", "value": "r5d.12xlarge" }, { "name": "R5d_16XLarge", "value": "r5d.16xlarge" }, { "name": "R5d_24XLarge", "value": "r5d.24xlarge" }, { "name": "R5d_2XLarge", "value": "r5d.2xlarge" }, { "name": "R5d_4XLarge", "value": "r5d.4xlarge" }, { "name": "R5d_8XLarge", "value": "r5d.8xlarge" }, { "name": "R5d_Large", "value": "r5d.large" }, { "name": "R5d_Metal", "value": "r5d.metal" }, { "name": "R5d_XLarge", "value": "r5d.xlarge" }, { "name": "R5dn_12XLarge", "value": "r5dn.12xlarge" }, { "name": "R5dn_16XLarge", "value": "r5dn.16xlarge" }, { "name": "R5dn_24XLarge", "value": "r5dn.24xlarge" }, { "name": "R5dn_2XLarge", "value": "r5dn.2xlarge" }, { "name": "R5dn_4XLarge", "value": "r5dn.4xlarge" }, { "name": "R5dn_8XLarge", "value": "r5dn.8xlarge" }, { "name": "R5dn_Large", "value": "r5dn.large" }, { "name": "R5dn_Metal", "value": "r5dn.metal" }, { "name": "R5dn_XLarge", "value": "r5dn.xlarge" }, { "name": "R5n_12XLarge", "value": "r5n.12xlarge" }, { "name": "R5n_16XLarge", "value": "r5n.16xlarge" }, { "name": "R5n_24XLarge", "value": "r5n.24xlarge" }, { "name": "R5n_2XLarge", "value": "r5n.2xlarge" }, { "name": "R5n_4XLarge", "value": "r5n.4xlarge" }, { "name": "R5n_8XLarge", "value": "r5n.8xlarge" }, { "name": "R5n_Large", "value": "r5n.large" }, { "name": "R5n_Metal", "value": "r5n.metal" }, { "name": "R5n_XLarge", "value": "r5n.xlarge" }, { "name": "R6a_12XLarge", "value": "r6a.12xlarge" }, { "name": "R6a_16XLarge", "value": "r6a.16xlarge" }, { "name": "R6a_24XLarge", "value": "r6a.24xlarge" }, { "name": "R6a_2XLarge", "value": "r6a.2xlarge" }, { "name": "R6a_32XLarge", "value": "r6a.32xlarge" }, { "name": "R6a_48XLarge", "value": "r6a.48xlarge" }, { "name": "R6a_4XLarge", "value": "r6a.4xlarge" }, { "name": "R6a_8XLarge", "value": "r6a.8xlarge" }, { "name": "R6a_Large", "value": "r6a.large" }, { "name": "R6a_Metal", "value": "r6a.metal" }, { "name": "R6a_XLarge", "value": "r6a.xlarge" }, { "name": "R6g_12XLarge", "value": "r6g.12xlarge" }, { "name": "R6g_16XLarge", "value": "r6g.16xlarge" }, { "name": "R6g_2XLarge", "value": "r6g.2xlarge" }, { "name": "R6g_4XLarge", "value": "r6g.4xlarge" }, { "name": "R6g_8XLarge", "value": "r6g.8xlarge" }, { "name": "R6g_Large", "value": "r6g.large" }, { "name": "R6g_Medium", "value": "r6g.medium" }, { "name": "R6g_Metal", "value": "r6g.metal" }, { "name": "R6g_XLarge", "value": "r6g.xlarge" }, { "name": "R6gd_12XLarge", "value": "r6gd.12xlarge" }, { "name": "R6gd_16XLarge", "value": "r6gd.16xlarge" }, { "name": "R6gd_2XLarge", "value": "r6gd.2xlarge" }, { "name": "R6gd_4XLarge", "value": "r6gd.4xlarge" }, { "name": "R6gd_8XLarge", "value": "r6gd.8xlarge" }, { "name": "R6gd_Large", "value": "r6gd.large" }, { "name": "R6gd_Medium", "value": "r6gd.medium" }, { "name": "R6gd_Metal", "value": "r6gd.metal" }, { "name": "R6gd_XLarge", "value": "r6gd.xlarge" }, { "name": "R6i_12XLarge", "value": "r6i.12xlarge" }, { "name": "R6i_16XLarge", "value": "r6i.16xlarge" }, { "name": "R6i_24XLarge", "value": "r6i.24xlarge" }, { "name": "R6i_2XLarge", "value": "r6i.2xlarge" }, { "name": "R6i_32XLarge", "value": "r6i.32xlarge" }, { "name": "R6i_4XLarge", "value": "r6i.4xlarge" }, { "name": "R6i_8XLarge", "value": "r6i.8xlarge" }, { "name": "R6i_Large", "value": "r6i.large" }, { "name": "R6i_Metal", "value": "r6i.metal" }, { "name": "R6i_XLarge", "value": "r6i.xlarge" }, { "name": "R6id_12XLarge", "value": "r6id.12xlarge" }, { "name": "R6id_16XLarge", "value": "r6id.16xlarge" }, { "name": "R6id_24XLarge", "value": "r6id.24xlarge" }, { "name": "R6id_2XLarge", "value": "r6id.2xlarge" }, { "name": "R6id_32XLarge", "value": "r6id.32xlarge" }, { "name": "R6id_4XLarge", "value": "r6id.4xlarge" }, { "name": "R6id_8XLarge", "value": "r6id.8xlarge" }, { "name": "R6id_Large", "value": "r6id.large" }, { "name": "R6id_Metal", "value": "r6id.metal" }, { "name": "R6id_XLarge", "value": "r6id.xlarge" }, { "name": "R6idn_12XLarge", "value": "r6idn.12xlarge" }, { "name": "R6idn_16XLarge", "value": "r6idn.16xlarge" }, { "name": "R6idn_24XLarge", "value": "r6idn.24xlarge" }, { "name": "R6idn_2XLarge", "value": "r6idn.2xlarge" }, { "name": "R6idn_32XLarge", "value": "r6idn.32xlarge" }, { "name": "R6idn_4XLarge", "value": "r6idn.4xlarge" }, { "name": "R6idn_8XLarge", "value": "r6idn.8xlarge" }, { "name": "R6idn_Large", "value": "r6idn.large" }, { "name": "R6idn_Metal", "value": "r6idn.metal" }, { "name": "R6idn_XLarge", "value": "r6idn.xlarge" }, { "name": "R6in_12XLarge", "value": "r6in.12xlarge" }, { "name": "R6in_16XLarge", "value": "r6in.16xlarge" }, { "name": "R6in_24XLarge", "value": "r6in.24xlarge" }, { "name": "R6in_2XLarge", "value": "r6in.2xlarge" }, { "name": "R6in_32XLarge", "value": "r6in.32xlarge" }, { "name": "R6in_4XLarge", "value": "r6in.4xlarge" }, { "name": "R6in_8XLarge", "value": "r6in.8xlarge" }, { "name": "R6in_Large", "value": "r6in.large" }, { "name": "R6in_Metal", "value": "r6in.metal" }, { "name": "R6in_XLarge", "value": "r6in.xlarge" }, { "name": "R7a_12XLarge", "value": "r7a.12xlarge" }, { "name": "R7a_16XLarge", "value": "r7a.16xlarge" }, { "name": "R7a_24XLarge", "value": "r7a.24xlarge" }, { "name": "R7a_2XLarge", "value": "r7a.2xlarge" }, { "name": "R7a_32XLarge", "value": "r7a.32xlarge" }, { "name": "R7a_48XLarge", "value": "r7a.48xlarge" }, { "name": "R7a_4XLarge", "value": "r7a.4xlarge" }, { "name": "R7a_8XLarge", "value": "r7a.8xlarge" }, { "name": "R7a_Large", "value": "r7a.large" }, { "name": "R7a_Medium", "value": "r7a.medium" }, { "name": "R7a_Metal_48xl", "value": "r7a.metal-48xl" }, { "name": "R7a_XLarge", "value": "r7a.xlarge" }, { "name": "R7g_12XLarge", "value": "r7g.12xlarge" }, { "name": "R7g_16XLarge", "value": "r7g.16xlarge" }, { "name": "R7g_2XLarge", "value": "r7g.2xlarge" }, { "name": "R7g_4XLarge", "value": "r7g.4xlarge" }, { "name": "R7g_8XLarge", "value": "r7g.8xlarge" }, { "name": "R7g_Large", "value": "r7g.large" }, { "name": "R7g_Medium", "value": "r7g.medium" }, { "name": "R7g_Metal", "value": "r7g.metal" }, { "name": "R7g_XLarge", "value": "r7g.xlarge" }, { "name": "R7gd_12XLarge", "value": "r7gd.12xlarge" }, { "name": "R7gd_16XLarge", "value": "r7gd.16xlarge" }, { "name": "R7gd_2XLarge", "value": "r7gd.2xlarge" }, { "name": "R7gd_4XLarge", "value": "r7gd.4xlarge" }, { "name": "R7gd_8XLarge", "value": "r7gd.8xlarge" }, { "name": "R7gd_Large", "value": "r7gd.large" }, { "name": "R7gd_Medium", "value": "r7gd.medium" }, { "name": "R7gd_Metal", "value": "r7gd.metal" }, { "name": "R7gd_XLarge", "value": "r7gd.xlarge" }, { "name": "R7i_12XLarge", "value": "r7i.12xlarge" }, { "name": "R7i_16XLarge", "value": "r7i.16xlarge" }, { "name": "R7i_24XLarge", "value": "r7i.24xlarge" }, { "name": "R7i_2XLarge", "value": "r7i.2xlarge" }, { "name": "R7i_48XLarge", "value": "r7i.48xlarge" }, { "name": "R7i_4XLarge", "value": "r7i.4xlarge" }, { "name": "R7i_8XLarge", "value": "r7i.8xlarge" }, { "name": "R7i_Large", "value": "r7i.large" }, { "name": "R7i_Metal_24xl", "value": "r7i.metal-24xl" }, { "name": "R7i_Metal_48xl", "value": "r7i.metal-48xl" }, { "name": "R7i_XLarge", "value": "r7i.xlarge" }, { "name": "R7iz_12XLarge", "value": "r7iz.12xlarge" }, { "name": "R7iz_16XLarge", "value": "r7iz.16xlarge" }, { "name": "R7iz_2XLarge", "value": "r7iz.2xlarge" }, { "name": "R7iz_32XLarge", "value": "r7iz.32xlarge" }, { "name": "R7iz_4XLarge", "value": "r7iz.4xlarge" }, { "name": "R7iz_8XLarge", "value": "r7iz.8xlarge" }, { "name": "R7iz_Large", "value": "r7iz.large" }, { "name": "R7iz_Metal_16xl", "value": "r7iz.metal-16xl" }, { "name": "R7iz_Metal_32xl", "value": "r7iz.metal-32xl" }, { "name": "R7iz_XLarge", "value": "r7iz.xlarge" }, { "name": "T1_Micro", "value": "t1.micro" }, { "name": "T2_2XLarge", "value": "t2.2xlarge" }, { "name": "T2_Large", "value": "t2.large" }, { "name": "T2_Medium", "value": "t2.medium" }, { "name": "T2_Micro", "value": "t2.micro" }, { "name": "T2_Nano", "value": "t2.nano" }, { "name": "T2_Small", "value": "t2.small" }, { "name": "T2_XLarge", "value": "t2.xlarge" }, { "name": "T3_2XLarge", "value": "t3.2xlarge" }, { "name": "T3_Large", "value": "t3.large" }, { "name": "T3_Medium", "value": "t3.medium" }, { "name": "T3_Micro", "value": "t3.micro" }, { "name": "T3_Nano", "value": "t3.nano" }, { "name": "T3_Small", "value": "t3.small" }, { "name": "T3_XLarge", "value": "t3.xlarge" }, { "name": "T3a_2XLarge", "value": "t3a.2xlarge" }, { "name": "T3a_Large", "value": "t3a.large" }, { "name": "T3a_Medium", "value": "t3a.medium" }, { "name": "T3a_Micro", "value": "t3a.micro" }, { "name": "T3a_Nano", "value": "t3a.nano" }, { "name": "T3a_Small", "value": "t3a.small" }, { "name": "T3a_XLarge", "value": "t3a.xlarge" }, { "name": "T4g_2XLarge", "value": "t4g.2xlarge" }, { "name": "T4g_Large", "value": "t4g.large" }, { "name": "T4g_Medium", "value": "t4g.medium" }, { "name": "T4g_Micro", "value": "t4g.micro" }, { "name": "T4g_Nano", "value": "t4g.nano" }, { "name": "T4g_Small", "value": "t4g.small" }, { "name": "T4g_XLarge", "value": "t4g.xlarge" }, { "name": "Trn1_2XLarge", "value": "trn1.2xlarge" }, { "name": "Trn1_32XLarge", "value": "trn1.32xlarge" }, { "name": "Trn1n_32XLarge", "value": "trn1n.32xlarge" }, { "name": "U_12tb1_112XLarge", "value": "u-12tb1.112xlarge" }, { "name": "U_18tb1_112XLarge", "value": "u-18tb1.112xlarge" }, { "name": "U_24tb1_112XLarge", "value": "u-24tb1.112xlarge" }, { "name": "U_3tb1_56XLarge", "value": "u-3tb1.56xlarge" }, { "name": "U_6tb1_112XLarge", "value": "u-6tb1.112xlarge" }, { "name": "U_6tb1_56XLarge", "value": "u-6tb1.56xlarge" }, { "name": "U_9tb1_112XLarge", "value": "u-9tb1.112xlarge" }, { "name": "Vt1_24XLarge", "value": "vt1.24xlarge" }, { "name": "Vt1_3XLarge", "value": "vt1.3xlarge" }, { "name": "Vt1_6XLarge", "value": "vt1.6xlarge" }, { "name": "X1_16XLarge", "value": "x1.16xlarge" }, { "name": "X1_32XLarge", "value": "x1.32xlarge" }, { "name": "X1e_16XLarge", "value": "x1e.16xlarge" }, { "name": "X1e_2XLarge", "value": "x1e.2xlarge" }, { "name": "X1e_32XLarge", "value": "x1e.32xlarge" }, { "name": "X1e_4XLarge", "value": "x1e.4xlarge" }, { "name": "X1e_8XLarge", "value": "x1e.8xlarge" }, { "name": "X1e_XLarge", "value": "x1e.xlarge" }, { "name": "X2gd_12XLarge", "value": "x2gd.12xlarge" }, { "name": "X2gd_16XLarge", "value": "x2gd.16xlarge" }, { "name": "X2gd_2XLarge", "value": "x2gd.2xlarge" }, { "name": "X2gd_4XLarge", "value": "x2gd.4xlarge" }, { "name": "X2gd_8XLarge", "value": "x2gd.8xlarge" }, { "name": "X2gd_Large", "value": "x2gd.large" }, { "name": "X2gd_Medium", "value": "x2gd.medium" }, { "name": "X2gd_Metal", "value": "x2gd.metal" }, { "name": "X2gd_XLarge", "value": "x2gd.xlarge" }, { "name": "X2idn_16XLarge", "value": "x2idn.16xlarge" }, { "name": "X2idn_24XLarge", "value": "x2idn.24xlarge" }, { "name": "X2idn_32XLarge", "value": "x2idn.32xlarge" }, { "name": "X2idn_Metal", "value": "x2idn.metal" }, { "name": "X2iedn_16XLarge", "value": "x2iedn.16xlarge" }, { "name": "X2iedn_24XLarge", "value": "x2iedn.24xlarge" }, { "name": "X2iedn_2XLarge", "value": "x2iedn.2xlarge" }, { "name": "X2iedn_32XLarge", "value": "x2iedn.32xlarge" }, { "name": "X2iedn_4XLarge", "value": "x2iedn.4xlarge" }, { "name": "X2iedn_8XLarge", "value": "x2iedn.8xlarge" }, { "name": "X2iedn_Metal", "value": "x2iedn.metal" }, { "name": "X2iedn_XLarge", "value": "x2iedn.xlarge" }, { "name": "X2iezn_12XLarge", "value": "x2iezn.12xlarge" }, { "name": "X2iezn_2XLarge", "value": "x2iezn.2xlarge" }, { "name": "X2iezn_4XLarge", "value": "x2iezn.4xlarge" }, { "name": "X2iezn_6XLarge", "value": "x2iezn.6xlarge" }, { "name": "X2iezn_8XLarge", "value": "x2iezn.8xlarge" }, { "name": "X2iezn_Metal", "value": "x2iezn.metal" }, { "name": "Z1d_12XLarge", "value": "z1d.12xlarge" }, { "name": "Z1d_2XLarge", "value": "z1d.2xlarge" }, { "name": "Z1d_3XLarge", "value": "z1d.3xlarge" }, { "name": "Z1d_6XLarge", "value": "z1d.6xlarge" }, { "name": "Z1d_Large", "value": "z1d.large" }, { "name": "Z1d_Metal", "value": "z1d.metal" }, { "name": "Z1d_XLarge", "value": "z1d.xlarge" }, { "name": "U_12tb1Metal", "value": "u-12tb1.metal", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "U_6tb1Metal", "value": "u-6tb1.metal", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "U_9tb1Metal", "value": "u-9tb1.metal", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "Hs1_8XLarge", "value": "hs1.8xlarge", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "M5as_XLarge", "value": "m5ad.xlarge", "deprecationMessage": "Has a typo, use M5ad_XLarge instead" }, { "name": "C7a_Metal", "value": "c7a.metal-48xl", "deprecationMessage": "Use C7a_Metal_48xl instead" }, { "name": "M7a_Metal", "value": "m7a.metal-48xl", "deprecationMessage": "Use M7a_Metal_48xl instead" }, { "name": "Cc2_8XLarge", "value": "cc2.8xlarge", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "G2_2XLarge", "value": "g2.2xlarge", "deprecationMessage": "This instancetype has been deprecated" }, { "name": "G2_8XLarge", "value": "g2.8xlarge", "deprecationMessage": "This instancetype has been deprecated" } ] }, "aws:ec2/LaunchConfigurationEbsBlockDevice:LaunchConfigurationEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "willReplaceOnChanges": true }, "deviceName": { "type": "string", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "willReplaceOnChanges": true }, "iops": { "type": "integer", "willReplaceOnChanges": true }, "noDevice": { "type": "boolean", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "snapshotId", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/LaunchConfigurationEphemeralBlockDevice:LaunchConfigurationEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "willReplaceOnChanges": true }, "noDevice": { "type": "boolean", "willReplaceOnChanges": true }, "virtualName": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ] }, "aws:ec2/LaunchConfigurationMetadataOptions:LaunchConfigurationMetadataOptions": { "properties": { "httpEndpoint": { "type": "string", "description": "The state of the metadata service: `enabled`, `disabled`.\n", "willReplaceOnChanges": true }, "httpPutResponseHopLimit": { "type": "integer", "description": "The desired HTTP PUT response hop limit for instance metadata requests.\n", "willReplaceOnChanges": true }, "httpTokens": { "type": "string", "description": "If session tokens are required: `optional`, `required`.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "httpEndpoint", "httpPutResponseHopLimit", "httpTokens" ] } } }, "aws:ec2/LaunchConfigurationRootBlockDevice:LaunchConfigurationRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "willReplaceOnChanges": true }, "iops": { "type": "integer", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "encrypted", "iops", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/LaunchTemplateBlockDeviceMapping:LaunchTemplateBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "The name of the device to mount.\n" }, "ebs": { "$ref": "#/types/aws:ec2/LaunchTemplateBlockDeviceMappingEbs:LaunchTemplateBlockDeviceMappingEbs", "description": "Configure EBS volume properties.\n" }, "noDevice": { "type": "string", "description": "Suppresses the specified device included in the AMI's block device mapping.\n" }, "virtualName": { "type": "string", "description": "The [Instance Store Device\nName](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#InstanceStoreDeviceNames)\n(e.g., `\"ephemeral0\"`).\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateBlockDeviceMappingEbs:LaunchTemplateBlockDeviceMappingEbs": { "properties": { "deleteOnTermination": { "type": "string", "description": "Whether the volume should be destroyed on instance termination.\nSee [Preserving Amazon EBS Volumes on Instance Termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/preserving-volumes-on-termination.html) for more information.\n" }, "encrypted": { "type": "string", "description": "Enables [EBS encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) on the volume.\nCannot be used with `snapshot_id`.\n" }, "iops": { "type": "integer", "description": "The amount of provisioned [IOPS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html).\nThis must be set with a `volume_type` of `\"io1/io2/gp3\"`.\n" }, "kmsKeyId": { "type": "string", "description": "The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.\n`encrypted` must be set to `true` when this is set.\n" }, "snapshotId": { "type": "string", "description": "The Snapshot ID to mount.\n" }, "throughput": { "type": "integer", "description": "The throughput to provision for a `gp3` volume in MiB/s (specified as an integer, e.g., 500), with a maximum of 1,000 MiB/s.\n" }, "volumeSize": { "type": "integer", "description": "The size of the volume in gigabytes.\n" }, "volumeType": { "type": "string", "description": "The volume type.\nCan be one of `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/LaunchTemplateCapacityReservationSpecification:LaunchTemplateCapacityReservationSpecification": { "properties": { "capacityReservationPreference": { "type": "string", "description": "Indicates the instance's Capacity Reservation preferences. Can be `open` or `none`. (Default `none`).\n" }, "capacityReservationTarget": { "$ref": "#/types/aws:ec2/LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget:LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget", "description": "Used to target a specific Capacity Reservation:\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget:LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget": { "properties": { "capacityReservationId": { "type": "string", "description": "The ID of the Capacity Reservation in which to run the instance.\n" }, "capacityReservationResourceGroupArn": { "type": "string", "description": "The ARN of the Capacity Reservation resource group in which to run the instance.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateCpuOptions:LaunchTemplateCpuOptions": { "properties": { "amdSevSnp": { "type": "string", "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. Valid values are `enabled` and `disabled`.\n" }, "coreCount": { "type": "integer", "description": "The number of CPU cores for the instance.\n" }, "threadsPerCore": { "type": "integer", "description": "The number of threads per CPU core.\nTo disable Intel Hyper-Threading Technology for the instance, specify a value of 1.\nOtherwise, specify the default value of 2.\n\nBoth number of CPU cores and threads per core must be specified. Valid number of CPU cores and threads per core for the instance type can be found in the [CPU Options Documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html?shortFooter=true#cpu-options-supported-instances-values)\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateCreditSpecification:LaunchTemplateCreditSpecification": { "properties": { "cpuCredits": { "type": "string", "description": "The credit option for CPU usage.\nCan be `standard` or `unlimited`.\nT3 instances are launched as `unlimited` by default.\nT2 instances are launched as `standard` by default.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateElasticGpuSpecification:LaunchTemplateElasticGpuSpecification": { "properties": { "type": { "type": "string", "description": "The [Elastic GPU Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-graphics.html#elastic-graphics-basics)\n" } }, "type": "object", "required": [ "type" ] }, "aws:ec2/LaunchTemplateElasticInferenceAccelerator:LaunchTemplateElasticInferenceAccelerator": { "properties": { "type": { "type": "string", "description": "Accelerator type.\n" } }, "type": "object", "required": [ "type" ] }, "aws:ec2/LaunchTemplateEnclaveOptions:LaunchTemplateEnclaveOptions": { "properties": { "enabled": { "type": "boolean", "description": "If set to `true`, Nitro Enclaves will be enabled on the instance.\n\nFor more information, see the documentation on [Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html).\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateHibernationOptions:LaunchTemplateHibernationOptions": { "properties": { "configured": { "type": "boolean", "description": "If set to `true`, the launched EC2 instance will hibernation enabled.\n" } }, "type": "object", "required": [ "configured" ] }, "aws:ec2/LaunchTemplateIamInstanceProfile:LaunchTemplateIamInstanceProfile": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the instance profile. Conflicts with `name`.\n" }, "name": { "type": "string", "description": "The name of the instance profile.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceMarketOptions:LaunchTemplateInstanceMarketOptions": { "properties": { "marketType": { "type": "string", "description": "The market type. Can be `spot`.\n" }, "spotOptions": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceMarketOptionsSpotOptions:LaunchTemplateInstanceMarketOptionsSpotOptions", "description": "The options for [Spot Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html)\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceMarketOptionsSpotOptions:LaunchTemplateInstanceMarketOptionsSpotOptions": { "properties": { "blockDurationMinutes": { "type": "integer", "description": "The required duration in minutes. This value must be a multiple of 60.\n" }, "instanceInterruptionBehavior": { "type": "string", "description": "The behavior when a Spot Instance is interrupted. Can be `hibernate`,\n`stop`, or `terminate`. (Default: `terminate`).\n" }, "maxPrice": { "type": "string", "description": "The maximum hourly price you're willing to pay for the Spot Instances.\n" }, "spotInstanceType": { "type": "string", "description": "The Spot Instance request type. Can be `one-time`, or `persistent`.\n" }, "validUntil": { "type": "string", "description": "The end date of the request.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "validUntil" ] } } }, "aws:ec2/LaunchTemplateInstanceRequirements:LaunchTemplateInstanceRequirements": { "properties": { "acceleratorCount": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsAcceleratorCount:LaunchTemplateInstanceRequirementsAcceleratorCount", "description": "Block describing the minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips). Default is no minimum or maximum.\n" }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator manufacturer names. Default is any manufacturer.\n\n```\nValid names:\n* amazon-web-services\n* amd\n* nvidia\n* xilinx\n```\n" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator names. Default is any acclerator.\n\n```\nValid names:\n* a100 - NVIDIA A100 GPUs\n* v100 - NVIDIA V100 GPUs\n* k80 - NVIDIA K80 GPUs\n* t4 - NVIDIA T4 GPUs\n* m60 - NVIDIA M60 GPUs\n* radeon-pro-v520 - AMD Radeon Pro V520 GPUs\n* vu9p - Xilinx VU9P FPGAs\n```\n" }, "acceleratorTotalMemoryMib": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsAcceleratorTotalMemoryMib:LaunchTemplateInstanceRequirementsAcceleratorTotalMemoryMib", "description": "Block describing the minimum and maximum total memory of the accelerators. Default is no minimum or maximum.\n" }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator types. Default is any accelerator type.\n\n```\nValid types:\n* fpga\n* gpu\n* inference\n```\n" }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. 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*`. For example, if you specify `c5*`, you are allowing the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, you are allowing all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is all instance types.\n\n\u003e **NOTE:** If you specify `allowed_instance_types`, you can't specify `excluded_instance_types`.\n" }, "bareMetal": { "type": "string", "description": "Indicate whether bare metal instace types should be `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "baselineEbsBandwidthMbps": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsBaselineEbsBandwidthMbps:LaunchTemplateInstanceRequirementsBaselineEbsBandwidthMbps", "description": "Block describing the minimum and maximum baseline EBS bandwidth, in Mbps. Default is no minimum or maximum.\n" }, "burstablePerformance": { "type": "string", "description": "Indicate whether burstable performance instance types should be `included`, `excluded`, or `required`. Default is `excluded`.\n" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of CPU manufacturer names. Default is any manufacturer.\n\n\u003e **NOTE:** 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\n```\nValid names:\n* amazon-web-services\n* amd\n* intel\n```\n" }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to exclude. 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*`. 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.*`, you are excluding all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is no excluded instance types.\n\n\u003e **NOTE:** If you specify `excluded_instance_types`, you can't specify `allowed_instance_types`.\n" }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "List of instance generation names. Default is any generation.\n\n```\nValid names:\n* current - Recommended for best performance.\n* previous - For existing applications optimized for older instance types.\n```\n" }, "localStorage": { "type": "string", "description": "Indicate whether instance types with local storage volumes are `included`, `excluded`, or `required`. Default is `included`.\n" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "List of local storage type names. Default any storage type.\n\n```\nValue names:\n* hdd - hard disk drive\n* ssd - solid state drive\n```\n" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Conflicts with `spot_max_price_percentage_over_lowest_price`\n" }, "memoryGibPerVcpu": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsMemoryGibPerVcpu:LaunchTemplateInstanceRequirementsMemoryGibPerVcpu", "description": "Block describing the minimum and maximum amount of memory (GiB) per vCPU. Default is no minimum or maximum.\n" }, "memoryMib": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsMemoryMib:LaunchTemplateInstanceRequirementsMemoryMib", "description": "Block describing the minimum and maximum amount of memory (MiB). Default is no maximum.\n" }, "networkBandwidthGbps": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsNetworkBandwidthGbps:LaunchTemplateInstanceRequirementsNetworkBandwidthGbps", "description": "Block describing the minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default is no minimum or maximum.\n" }, "networkInterfaceCount": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsNetworkInterfaceCount:LaunchTemplateInstanceRequirementsNetworkInterfaceCount", "description": "Block describing the minimum and maximum number of network interfaces. Default is no minimum or maximum.\n" }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 20.\n\nIf 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" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicate whether instance types must support On-Demand Instance Hibernation, either `true` or `false`. Default is `false`.\n" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 100. Conflicts with `max_spot_price_as_percentage_of_optimal_on_demand_price`\n\nIf 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" }, "totalLocalStorageGb": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsTotalLocalStorageGb:LaunchTemplateInstanceRequirementsTotalLocalStorageGb", "description": "Block describing the minimum and maximum total local storage (GB). Default is no minimum or maximum.\n" }, "vcpuCount": { "$ref": "#/types/aws:ec2/LaunchTemplateInstanceRequirementsVcpuCount:LaunchTemplateInstanceRequirementsVcpuCount", "description": "Block describing the minimum and maximum number of vCPUs. Default is no maximum.\n" } }, "type": "object", "required": [ "memoryMib", "vcpuCount" ] }, "aws:ec2/LaunchTemplateInstanceRequirementsAcceleratorCount:LaunchTemplateInstanceRequirementsAcceleratorCount": { "properties": { "max": { "type": "integer", "description": "Maximum. Set to `0` to exclude instance types with accelerators.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsAcceleratorTotalMemoryMib:LaunchTemplateInstanceRequirementsAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsBaselineEbsBandwidthMbps:LaunchTemplateInstanceRequirementsBaselineEbsBandwidthMbps": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsMemoryGibPerVcpu:LaunchTemplateInstanceRequirementsMemoryGibPerVcpu": { "properties": { "max": { "type": "number", "description": "Maximum. May be a decimal number, e.g. `0.5`.\n" }, "min": { "type": "number", "description": "Minimum. May be a decimal number, e.g. `0.5`.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsMemoryMib:LaunchTemplateInstanceRequirementsMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "min" ] }, "aws:ec2/LaunchTemplateInstanceRequirementsNetworkBandwidthGbps:LaunchTemplateInstanceRequirementsNetworkBandwidthGbps": { "properties": { "max": { "type": "number", "description": "Maximum.\n" }, "min": { "type": "number", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsNetworkInterfaceCount:LaunchTemplateInstanceRequirementsNetworkInterfaceCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsTotalLocalStorageGb:LaunchTemplateInstanceRequirementsTotalLocalStorageGb": { "properties": { "max": { "type": "number", "description": "Maximum. May be a decimal number, e.g. `0.5`.\n" }, "min": { "type": "number", "description": "Minimum. May be a decimal number, e.g. `0.5`.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateInstanceRequirementsVcpuCount:LaunchTemplateInstanceRequirementsVcpuCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n" }, "min": { "type": "integer", "description": "Minimum.\n" } }, "type": "object", "required": [ "min" ] }, "aws:ec2/LaunchTemplateLicenseSpecification:LaunchTemplateLicenseSpecification": { "properties": { "licenseConfigurationArn": { "type": "string", "description": "ARN of the license configuration.\n" } }, "type": "object", "required": [ "licenseConfigurationArn" ] }, "aws:ec2/LaunchTemplateMaintenanceOptions:LaunchTemplateMaintenanceOptions": { "properties": { "autoRecovery": { "type": "string", "description": "Disables the automatic recovery behavior of your instance or sets it to default. Can be `\"default\"` or `\"disabled\"`. See [Recover your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html) for more details.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateMetadataOptions:LaunchTemplateMetadataOptions": { "properties": { "httpEndpoint": { "type": "string", "description": "Whether the metadata service is available. Can be `\"enabled\"` or `\"disabled\"`. (Default: `\"enabled\"`).\n" }, "httpProtocolIpv6": { "type": "string", "description": "Enables or disables the IPv6 endpoint for the instance metadata service. Can be `\"enabled\"` or `\"disabled\"`.\n" }, "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. Can be an integer from `1` to `64`. (Default: `1`).\n" }, "httpTokens": { "type": "string", "description": "Whether or not the metadata service requires session tokens, also referred to as _Instance Metadata Service Version 2 (IMDSv2)_. Can be `\"optional\"` or `\"required\"`. (Default: `\"optional\"`).\n" }, "instanceMetadataTags": { "type": "string", "description": "Enables or disables access to instance tags from the instance metadata service. Can be `\"enabled\"` or `\"disabled\"`.\n\nFor more information, see the documentation on the [Instance Metadata Service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "httpEndpoint", "httpProtocolIpv6", "httpPutResponseHopLimit", "httpTokens", "instanceMetadataTags" ] } } }, "aws:ec2/LaunchTemplateMonitoring:LaunchTemplateMonitoring": { "properties": { "enabled": { "type": "boolean", "description": "If `true`, the launched EC2 instance will have detailed monitoring enabled.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateNetworkInterface:LaunchTemplateNetworkInterface": { "properties": { "associateCarrierIpAddress": { "type": "string", "description": "Associate a Carrier IP address with `eth0` for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. Boolean value, can be left unset.\n" }, "associatePublicIpAddress": { "type": "string", "description": "Associate a public ip address with the network interface. Boolean value, can be left unset.\n" }, "connectionTrackingSpecification": { "$ref": "#/types/aws:ec2/LaunchTemplateNetworkInterfaceConnectionTrackingSpecification:LaunchTemplateNetworkInterfaceConnectionTrackingSpecification", "description": "The Connection Tracking Configuration for the network interface. See [Amazon EC2 security group connection tracking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts)\n" }, "deleteOnTermination": { "type": "string", "description": "Whether the network interface should be destroyed on instance termination.\n" }, "description": { "type": "string", "description": "Description of the network interface.\n" }, "deviceIndex": { "type": "integer", "description": "The integer index of the network interface attachment.\n" }, "enaSrdSpecification": { "$ref": "#/types/aws:ec2/LaunchTemplateNetworkInterfaceEnaSrdSpecification:LaunchTemplateNetworkInterfaceEnaSrdSpecification", "description": "Configuration for Elastic Network Adapter (ENA) Express settings. Applies to network interfaces that use the [ena Express](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-ena-express.html) feature. See details below.\n" }, "interfaceType": { "type": "string", "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify `efa`.\n" }, "ipv4AddressCount": { "type": "integer", "description": "The number of secondary private IPv4 addresses to assign to a network interface. Conflicts with `ipv4_addresses`\n" }, "ipv4Addresses": { "type": "array", "items": { "type": "string" }, "description": "One or more private IPv4 addresses to associate. Conflicts with `ipv4_address_count`\n" }, "ipv4PrefixCount": { "type": "integer", "description": "The number of IPv4 prefixes to be automatically assigned to the network interface. Conflicts with `ipv4_prefixes`\n" }, "ipv4Prefixes": { "type": "array", "items": { "type": "string" }, "description": "One or more IPv4 prefixes to be assigned to the network interface. Conflicts with `ipv4_prefix_count`\n" }, "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses to assign to a network interface. Conflicts with `ipv6_addresses`\n" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. Conflicts with `ipv6_address_count`\n" }, "ipv6PrefixCount": { "type": "integer", "description": "The number of IPv6 prefixes to be automatically assigned to the network interface. Conflicts with `ipv6_prefixes`\n" }, "ipv6Prefixes": { "type": "array", "items": { "type": "string" }, "description": "One or more IPv6 prefixes to be assigned to the network interface. Conflicts with `ipv6_prefix_count`\n" }, "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.\n" }, "networkInterfaceId": { "type": "string", "description": "The ID of the network interface to attach.\n" }, "primaryIpv6": { "type": "string", "description": "Whether the first IPv6 GUA will be made the primary IPv6 address.\n" }, "privateIpAddress": { "type": "string", "description": "The primary private IPv4 address.\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs to associate.\n" }, "subnetId": { "type": "string", "description": "The VPC Subnet ID to associate.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateNetworkInterfaceConnectionTrackingSpecification:LaunchTemplateNetworkInterfaceConnectionTrackingSpecification": { "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.\n" }, "udpStreamTimeout": { "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.\n" }, "udpTimeout": { "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.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateNetworkInterfaceEnaSrdSpecification:LaunchTemplateNetworkInterfaceEnaSrdSpecification": { "properties": { "enaSrdEnabled": { "type": "boolean", "description": "Whether to enable ENA Express. ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to improve the performance of TCP traffic.\n" }, "enaSrdUdpSpecification": { "$ref": "#/types/aws:ec2/LaunchTemplateNetworkInterfaceEnaSrdSpecificationEnaSrdUdpSpecification:LaunchTemplateNetworkInterfaceEnaSrdSpecificationEnaSrdUdpSpecification", "description": "Configuration for ENA Express UDP optimization. See details below.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateNetworkInterfaceEnaSrdSpecificationEnaSrdUdpSpecification:LaunchTemplateNetworkInterfaceEnaSrdSpecificationEnaSrdUdpSpecification": { "properties": { "enaSrdUdpEnabled": { "type": "boolean", "description": "Whether to enable UDP traffic optimization through ENA Express. Requires `ena_srd_enabled` to be `true`.\n\nNOTE: ENA Express requires [specific instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-ena-express.html#ena-express-requirements) and minimum bandwidth of 25 Gbps.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplatePlacement:LaunchTemplatePlacement": { "properties": { "affinity": { "type": "string", "description": "The affinity setting for an instance on a Dedicated Host.\n" }, "availabilityZone": { "type": "string", "description": "The Availability Zone for the instance.\n" }, "groupName": { "type": "string", "description": "The name of the placement group for the instance.\n" }, "hostId": { "type": "string", "description": "The ID of the Dedicated Host for the instance.\n" }, "hostResourceGroupArn": { "type": "string", "description": "The ARN of the Host Resource Group in which to launch instances.\n" }, "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.\n" }, "spreadDomain": { "type": "string", "description": "Reserved for future use.\n" }, "tenancy": { "type": "string", "description": "The tenancy of the instance (if the instance is running in a VPC). Can be `default`, `dedicated`, or `host`.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplatePrivateDnsNameOptions:LaunchTemplatePrivateDnsNameOptions": { "properties": { "enableResourceNameDnsARecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n" }, "enableResourceNameDnsAaaaRecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n" }, "hostnameType": { "type": "string", "description": "The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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. Valid values: `ip-name` and `resource-name`.\n" } }, "type": "object" }, "aws:ec2/LaunchTemplateTagSpecification:LaunchTemplateTagSpecification": { "properties": { "resourceType": { "type": "string", "description": "The type of resource to tag.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags to assign to the resource.\n" } }, "type": "object" }, "aws:ec2/ManagedPrefixListEntry:ManagedPrefixListEntry": { "properties": { "cidr": { "type": "string", "description": "CIDR block of this entry.\n" }, "description": { "type": "string", "description": "Description of this entry. Due to API limitations, updating only the description of an existing entry requires temporarily removing and re-adding the entry.\n" } }, "type": "object", "required": [ "cidr" ] }, "aws:ec2/NetworkAclEgress:NetworkAclEgress": { "properties": { "action": { "type": "string", "description": "The action to take.\n" }, "cidrBlock": { "type": "string", "description": "The CIDR block to match. This must be a\nvalid network mask.\n" }, "fromPort": { "type": "integer", "description": "The from port to match.\n" }, "icmpCode": { "type": "integer", "description": "The ICMP type code to be used. Default 0.\n\n\u003e Note: For more information on ICMP types and codes, see here: https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml\n" }, "icmpType": { "type": "integer", "description": "The ICMP type to be used. Default 0.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block.\n" }, "protocol": { "type": "string", "description": "The protocol to match. If using the -1 'all'\nprotocol, you must specify a from and to port of 0.\n" }, "ruleNo": { "type": "integer", "description": "The rule number. Used for ordering.\n" }, "toPort": { "type": "integer", "description": "The to port to match.\n" } }, "type": "object", "required": [ "action", "fromPort", "protocol", "ruleNo", "toPort" ] }, "aws:ec2/NetworkAclIngress:NetworkAclIngress": { "properties": { "action": { "type": "string", "description": "The action to take.\n" }, "cidrBlock": { "type": "string", "description": "The CIDR block to match. This must be a\nvalid network mask.\n" }, "fromPort": { "type": "integer", "description": "The from port to match.\n" }, "icmpCode": { "type": "integer", "description": "The ICMP type code to be used. Default 0.\n\n\u003e Note: For more information on ICMP types and codes, see here: https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml\n" }, "icmpType": { "type": "integer", "description": "The ICMP type to be used. Default 0.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block.\n" }, "protocol": { "type": "string", "description": "The protocol to match. If using the -1 'all'\nprotocol, you must specify a from and to port of 0.\n" }, "ruleNo": { "type": "integer", "description": "The rule number. Used for ordering.\n" }, "toPort": { "type": "integer", "description": "The to port to match.\n" } }, "type": "object", "required": [ "action", "fromPort", "protocol", "ruleNo", "toPort" ] }, "aws:ec2/NetworkInsightsAnalysisAlternatePathHint:NetworkInsightsAnalysisAlternatePathHint": { "properties": { "componentArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the component.\n" }, "componentId": { "type": "string", "description": "The ID of the component.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentArn", "componentId" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanation:NetworkInsightsAnalysisExplanation": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationAclRule:NetworkInsightsAnalysisExplanationAclRule" } }, "acls": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationAcl:NetworkInsightsAnalysisExplanationAcl" } }, "address": { "type": "string" }, "addresses": { "type": "array", "items": { "type": "string" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationAttachedTo:NetworkInsightsAnalysisExplanationAttachedTo" } }, "availabilityZones": { "type": "array", "items": { "type": "string" } }, "cidrs": { "type": "array", "items": { "type": "string" } }, "classicLoadBalancerListeners": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationClassicLoadBalancerListener:NetworkInsightsAnalysisExplanationClassicLoadBalancerListener" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationComponent:NetworkInsightsAnalysisExplanationComponent" } }, "customerGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationCustomerGateway:NetworkInsightsAnalysisExplanationCustomerGateway" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationDestinationVpc:NetworkInsightsAnalysisExplanationDestinationVpc" } }, "destinations": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationDestination:NetworkInsightsAnalysisExplanationDestination" } }, "direction": { "type": "string" }, "elasticLoadBalancerListeners": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationElasticLoadBalancerListener:NetworkInsightsAnalysisExplanationElasticLoadBalancerListener" } }, "explanationCode": { "type": "string" }, "ingressRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationIngressRouteTable:NetworkInsightsAnalysisExplanationIngressRouteTable" } }, "internetGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationInternetGateway:NetworkInsightsAnalysisExplanationInternetGateway" } }, "loadBalancerArn": { "type": "string" }, "loadBalancerListenerPort": { "type": "integer" }, "loadBalancerTargetGroup": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup" } }, "loadBalancerTargetGroups": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup" } }, "loadBalancerTargetPort": { "type": "integer" }, "missingComponent": { "type": "string" }, "natGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationNatGateway:NetworkInsightsAnalysisExplanationNatGateway" } }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationNetworkInterface:NetworkInsightsAnalysisExplanationNetworkInterface" } }, "packetField": { "type": "string" }, "port": { "type": "integer" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationPortRange:NetworkInsightsAnalysisExplanationPortRange" } }, "prefixLists": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationPrefixList:NetworkInsightsAnalysisExplanationPrefixList" } }, "protocols": { "type": "array", "items": { "type": "string" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationRouteTableRoute:NetworkInsightsAnalysisExplanationRouteTableRoute" } }, "routeTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationRouteTable:NetworkInsightsAnalysisExplanationRouteTable" } }, "securityGroup": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroup:NetworkInsightsAnalysisExplanationSecurityGroup" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroupRule:NetworkInsightsAnalysisExplanationSecurityGroupRule" } }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroup:NetworkInsightsAnalysisExplanationSecurityGroup" } }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSourceVpc:NetworkInsightsAnalysisExplanationSourceVpc" } }, "state": { "type": "string" }, "subnetRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSubnetRouteTable:NetworkInsightsAnalysisExplanationSubnetRouteTable" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSubnet:NetworkInsightsAnalysisExplanationSubnet" } }, "transitGatewayAttachments": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayAttachment:NetworkInsightsAnalysisExplanationTransitGatewayAttachment" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute:NetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute" } }, "transitGatewayRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayRouteTable:NetworkInsightsAnalysisExplanationTransitGatewayRouteTable" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationTransitGateway:NetworkInsightsAnalysisExplanationTransitGateway" } }, "vpcEndpoints": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationVpcEndpoint:NetworkInsightsAnalysisExplanationVpcEndpoint" } }, "vpcPeeringConnections": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationVpcPeeringConnection:NetworkInsightsAnalysisExplanationVpcPeeringConnection" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationVpc:NetworkInsightsAnalysisExplanationVpc" } }, "vpnConnections": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationVpnConnection:NetworkInsightsAnalysisExplanationVpnConnection" } }, "vpnGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationVpnGateway:NetworkInsightsAnalysisExplanationVpnGateway" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclRules", "acls", "address", "addresses", "attachedTos", "availabilityZones", "cidrs", "classicLoadBalancerListeners", "components", "customerGateways", "destinationVpcs", "destinations", "direction", "elasticLoadBalancerListeners", "explanationCode", "ingressRouteTables", "internetGateways", "loadBalancerArn", "loadBalancerListenerPort", "loadBalancerTargetGroup", "loadBalancerTargetGroups", "loadBalancerTargetPort", "missingComponent", "natGateways", "networkInterfaces", "packetField", "port", "portRanges", "prefixLists", "protocols", "routeTableRoutes", "routeTables", "securityGroup", "securityGroupRules", "securityGroups", "sourceVpcs", "state", "subnetRouteTables", "subnets", "transitGatewayAttachments", "transitGatewayRouteTableRoutes", "transitGatewayRouteTables", "transitGateways", "vpcEndpoints", "vpcPeeringConnections", "vpcs", "vpnConnections", "vpnGateways" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationAcl:NetworkInsightsAnalysisExplanationAcl": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationAclRule:NetworkInsightsAnalysisExplanationAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationAclRulePortRange:NetworkInsightsAnalysisExplanationAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationAclRulePortRange:NetworkInsightsAnalysisExplanationAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationAttachedTo:NetworkInsightsAnalysisExplanationAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationClassicLoadBalancerListener:NetworkInsightsAnalysisExplanationClassicLoadBalancerListener": { "properties": { "instancePort": { "type": "integer" }, "loadBalancerPort": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instancePort", "loadBalancerPort" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationComponent:NetworkInsightsAnalysisExplanationComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationCustomerGateway:NetworkInsightsAnalysisExplanationCustomerGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationDestination:NetworkInsightsAnalysisExplanationDestination": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationDestinationVpc:NetworkInsightsAnalysisExplanationDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationElasticLoadBalancerListener:NetworkInsightsAnalysisExplanationElasticLoadBalancerListener": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationIngressRouteTable:NetworkInsightsAnalysisExplanationIngressRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationInternetGateway:NetworkInsightsAnalysisExplanationInternetGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:NetworkInsightsAnalysisExplanationLoadBalancerTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationNatGateway:NetworkInsightsAnalysisExplanationNatGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationNetworkInterface:NetworkInsightsAnalysisExplanationNetworkInterface": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationPortRange:NetworkInsightsAnalysisExplanationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationPrefixList:NetworkInsightsAnalysisExplanationPrefixList": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationRouteTable:NetworkInsightsAnalysisExplanationRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationRouteTableRoute:NetworkInsightsAnalysisExplanationRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroup:NetworkInsightsAnalysisExplanationSecurityGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroupRule:NetworkInsightsAnalysisExplanationSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroupRulePortRange:NetworkInsightsAnalysisExplanationSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSecurityGroupRulePortRange:NetworkInsightsAnalysisExplanationSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSourceVpc:NetworkInsightsAnalysisExplanationSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSubnet:NetworkInsightsAnalysisExplanationSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationSubnetRouteTable:NetworkInsightsAnalysisExplanationSubnetRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationTransitGateway:NetworkInsightsAnalysisExplanationTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayAttachment:NetworkInsightsAnalysisExplanationTransitGatewayAttachment": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayRouteTable:NetworkInsightsAnalysisExplanationTransitGatewayRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute:NetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationVpc:NetworkInsightsAnalysisExplanationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationVpcEndpoint:NetworkInsightsAnalysisExplanationVpcEndpoint": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationVpcPeeringConnection:NetworkInsightsAnalysisExplanationVpcPeeringConnection": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationVpnConnection:NetworkInsightsAnalysisExplanationVpnConnection": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisExplanationVpnGateway:NetworkInsightsAnalysisExplanationVpnGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponent:NetworkInsightsAnalysisForwardPathComponent": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentAclRule:NetworkInsightsAnalysisForwardPathComponentAclRule" } }, "additionalDetails": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentAdditionalDetail:NetworkInsightsAnalysisForwardPathComponentAdditionalDetail" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentAttachedTo:NetworkInsightsAnalysisForwardPathComponentAttachedTo" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentComponent:NetworkInsightsAnalysisForwardPathComponentComponent" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentDestinationVpc:NetworkInsightsAnalysisForwardPathComponentDestinationVpc" } }, "inboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeader:NetworkInsightsAnalysisForwardPathComponentInboundHeader" } }, "outboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeader:NetworkInsightsAnalysisForwardPathComponentOutboundHeader" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentRouteTableRoute:NetworkInsightsAnalysisForwardPathComponentRouteTableRoute" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentSecurityGroupRule:NetworkInsightsAnalysisForwardPathComponentSecurityGroupRule" } }, "sequenceNumber": { "type": "integer" }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentSourceVpc:NetworkInsightsAnalysisForwardPathComponentSourceVpc" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentSubnet:NetworkInsightsAnalysisForwardPathComponentSubnet" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute:NetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentTransitGateway:NetworkInsightsAnalysisForwardPathComponentTransitGateway" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentVpc:NetworkInsightsAnalysisForwardPathComponentVpc" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclRules", "additionalDetails", "attachedTos", "components", "destinationVpcs", "inboundHeaders", "outboundHeaders", "routeTableRoutes", "securityGroupRules", "sequenceNumber", "sourceVpcs", "subnets", "transitGatewayRouteTableRoutes", "transitGateways", "vpcs" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentAclRule:NetworkInsightsAnalysisForwardPathComponentAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentAclRulePortRange:NetworkInsightsAnalysisForwardPathComponentAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentAclRulePortRange:NetworkInsightsAnalysisForwardPathComponentAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentAdditionalDetail:NetworkInsightsAnalysisForwardPathComponentAdditionalDetail": { "properties": { "additionalDetailType": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent:NetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalDetailType", "components" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent:NetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentAttachedTo:NetworkInsightsAnalysisForwardPathComponentAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentComponent:NetworkInsightsAnalysisForwardPathComponentComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentDestinationVpc:NetworkInsightsAnalysisForwardPathComponentDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeader:NetworkInsightsAnalysisForwardPathComponentInboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange:NetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange:NetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange:NetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange:NetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeader:NetworkInsightsAnalysisForwardPathComponentOutboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange:NetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange:NetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange:NetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange:NetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentRouteTableRoute:NetworkInsightsAnalysisForwardPathComponentRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentSecurityGroupRule:NetworkInsightsAnalysisForwardPathComponentSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange:NetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange:NetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentSourceVpc:NetworkInsightsAnalysisForwardPathComponentSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentSubnet:NetworkInsightsAnalysisForwardPathComponentSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentTransitGateway:NetworkInsightsAnalysisForwardPathComponentTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute:NetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ] } } }, "aws:ec2/NetworkInsightsAnalysisForwardPathComponentVpc:NetworkInsightsAnalysisForwardPathComponentVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponent:NetworkInsightsAnalysisReturnPathComponent": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentAclRule:NetworkInsightsAnalysisReturnPathComponentAclRule" } }, "additionalDetails": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentAdditionalDetail:NetworkInsightsAnalysisReturnPathComponentAdditionalDetail" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentAttachedTo:NetworkInsightsAnalysisReturnPathComponentAttachedTo" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentComponent:NetworkInsightsAnalysisReturnPathComponentComponent" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentDestinationVpc:NetworkInsightsAnalysisReturnPathComponentDestinationVpc" } }, "inboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeader:NetworkInsightsAnalysisReturnPathComponentInboundHeader" } }, "outboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeader:NetworkInsightsAnalysisReturnPathComponentOutboundHeader" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentRouteTableRoute:NetworkInsightsAnalysisReturnPathComponentRouteTableRoute" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentSecurityGroupRule:NetworkInsightsAnalysisReturnPathComponentSecurityGroupRule" } }, "sequenceNumber": { "type": "integer" }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentSourceVpc:NetworkInsightsAnalysisReturnPathComponentSourceVpc" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentSubnet:NetworkInsightsAnalysisReturnPathComponentSubnet" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute:NetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentTransitGateway:NetworkInsightsAnalysisReturnPathComponentTransitGateway" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentVpc:NetworkInsightsAnalysisReturnPathComponentVpc" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclRules", "additionalDetails", "attachedTos", "components", "destinationVpcs", "inboundHeaders", "outboundHeaders", "routeTableRoutes", "securityGroupRules", "sequenceNumber", "sourceVpcs", "subnets", "transitGatewayRouteTableRoutes", "transitGateways", "vpcs" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentAclRule:NetworkInsightsAnalysisReturnPathComponentAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentAclRulePortRange:NetworkInsightsAnalysisReturnPathComponentAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentAclRulePortRange:NetworkInsightsAnalysisReturnPathComponentAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentAdditionalDetail:NetworkInsightsAnalysisReturnPathComponentAdditionalDetail": { "properties": { "additionalDetailType": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent:NetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalDetailType", "components" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent:NetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentAttachedTo:NetworkInsightsAnalysisReturnPathComponentAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentComponent:NetworkInsightsAnalysisReturnPathComponentComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentDestinationVpc:NetworkInsightsAnalysisReturnPathComponentDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeader:NetworkInsightsAnalysisReturnPathComponentInboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange:NetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange:NetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange:NetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange:NetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeader:NetworkInsightsAnalysisReturnPathComponentOutboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange:NetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange:NetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange:NetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange:NetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentRouteTableRoute:NetworkInsightsAnalysisReturnPathComponentRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentSecurityGroupRule:NetworkInsightsAnalysisReturnPathComponentSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/NetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange:NetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange:NetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentSourceVpc:NetworkInsightsAnalysisReturnPathComponentSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentSubnet:NetworkInsightsAnalysisReturnPathComponentSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentTransitGateway:NetworkInsightsAnalysisReturnPathComponentTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute:NetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ] } } }, "aws:ec2/NetworkInsightsAnalysisReturnPathComponentVpc:NetworkInsightsAnalysisReturnPathComponentVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the Network Insights Analysis.\n" }, "id": { "type": "string", "description": "ID of the Network Insights Analysis.\n" }, "name": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "arn", "id", "name" ] } } }, "aws:ec2/NetworkInterfaceAttachment:NetworkInterfaceAttachment": { "properties": { "attachmentId": { "type": "string" }, "deviceIndex": { "type": "integer", "description": "Integer to define the devices index.\n" }, "instance": { "type": "string", "description": "ID of the instance to attach to.\n" } }, "type": "object", "required": [ "deviceIndex", "instance" ], "language": { "nodejs": { "requiredOutputs": [ "attachmentId", "deviceIndex", "instance" ] } } }, "aws:ec2/NetworkInterfacePermissionTimeouts:NetworkInterfacePermissionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:ec2/PeeringConnectionOptionsAccepter:PeeringConnectionOptionsAccepter": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Allow a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.\n" } }, "type": "object" }, "aws:ec2/PeeringConnectionOptionsRequester:PeeringConnectionOptionsRequester": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Allow a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.\n" } }, "type": "object" }, "aws:ec2/PlacementStrategy:PlacementStrategy": { "description": "The strategy of the placement group determines how the instances are organized within the group.\nSee https://docs.aws.amazon.com/cli/latest/reference/ec2/create-placement-group.html", "type": "string", "enum": [ { "name": "Spread", "description": "A `spread` placement group places instances on distinct hardware.", "value": "spread" }, { "name": "Cluster", "description": "A `cluster` placement group is a logical grouping of instances within a single\nAvailability Zone that benefit from low network latency, high network throughput.", "value": "cluster" } ] }, "aws:ec2/ProtocolType:ProtocolType": { "type": "string", "enum": [ { "name": "All", "value": "all" }, { "name": "TCP", "value": "tcp" }, { "name": "UDP", "value": "udp" }, { "name": "ICMP", "value": "icmp" } ] }, "aws:ec2/RouteTableRoute:RouteTableRoute": { "properties": { "carrierGatewayId": { "type": "string", "description": "Identifier of a carrier gateway. This attribute can only be used when the VPC contains a subnet which is associated with a Wavelength Zone.\n" }, "cidrBlock": { "type": "string", "description": "The CIDR block of the route.\n" }, "coreNetworkArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of a core network.\n" }, "destinationPrefixListId": { "type": "string", "description": "The ID of a managed prefix list destination of the route.\n\nOne of the following target arguments must be supplied:\n" }, "egressOnlyGatewayId": { "type": "string", "description": "Identifier of a VPC Egress Only Internet Gateway.\n" }, "gatewayId": { "type": "string", "description": "Identifier of a VPC internet gateway, virtual private gateway, or `local`. `local` routes cannot be created but can be adopted or imported. See the example above.\n" }, "ipv6CidrBlock": { "type": "string", "description": "The Ipv6 CIDR block of the route.\n" }, "localGatewayId": { "type": "string", "description": "Identifier of a Outpost local gateway.\n" }, "natGatewayId": { "type": "string", "description": "Identifier of a VPC NAT gateway.\n" }, "networkInterfaceId": { "type": "string", "description": "Identifier of an EC2 network interface.\n" }, "transitGatewayId": { "type": "string", "description": "Identifier of an EC2 Transit Gateway.\n" }, "vpcEndpointId": { "type": "string", "description": "Identifier of a VPC Endpoint.\n" }, "vpcPeeringConnectionId": { "type": "string", "description": "Identifier of a VPC peering connection.\n\nNote that the default route, mapping the VPC's CIDR block to \"local\", is created implicitly and cannot be specified.\n" } }, "type": "object" }, "aws:ec2/SecurityGroupEgress:SecurityGroupEgress": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks.\n" }, "description": { "type": "string", "description": "Description of this egress rule.\n", "default": "" }, "fromPort": { "type": "integer", "description": "Start port (or ICMP type number if protocol is `icmp`)\n" }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 CIDR blocks.\n" }, "prefixListIds": { "type": "array", "items": { "type": "string" }, "description": "List of Prefix List IDs.\n" }, "protocol": { "type": "string", "description": "Protocol. If you select a protocol of `-1` (semantically equivalent to `all`, which is not a valid value here), you must specify a `from_port` and `to_port` equal to 0. The supported values are defined in the `IpProtocol` argument in the [IpPermission](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IpPermission.html) API reference.\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.\n" }, "self": { "type": "boolean", "description": "Whether the security group itself will be added as a source to this egress rule.\n" }, "toPort": { "type": "integer", "description": "End range port (or ICMP code if protocol is `icmp`).\n\nThe following arguments are optional:\n\n\u003e **Note** Although `cidr_blocks`, `ipv6_cidr_blocks`, `prefix_list_ids`, and `security_groups` are all marked as optional, you _must_ provide one of them in order to configure the destination of the traffic.\n" } }, "type": "object", "required": [ "fromPort", "protocol", "toPort" ], "language": { "nodejs": { "requiredOutputs": [ "description", "fromPort", "protocol", "toPort" ] } } }, "aws:ec2/SecurityGroupIngress:SecurityGroupIngress": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks.\n" }, "description": { "type": "string", "description": "Description of this ingress rule.\n", "default": "" }, "fromPort": { "type": "integer", "description": "Start port (or ICMP type number if protocol is `icmp` or `icmpv6`).\n" }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 CIDR blocks.\n" }, "prefixListIds": { "type": "array", "items": { "type": "string" }, "description": "List of Prefix List IDs.\n" }, "protocol": { "type": "string", "description": "Protocol. If you select a protocol of `-1` (semantically equivalent to `all`, which is not a valid value here), you must specify a `from_port` and `to_port` equal to 0. The supported values are defined in the `IpProtocol` argument on the [IpPermission](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IpPermission.html) API reference.\n\nThe following arguments are optional:\n\n\u003e **Note** Although `cidr_blocks`, `ipv6_cidr_blocks`, `prefix_list_ids`, and `security_groups` are all marked as optional, you _must_ provide one of them in order to configure the source of the traffic.\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.\n" }, "self": { "type": "boolean", "description": "Whether the security group itself will be added as a source to this ingress rule.\n" }, "toPort": { "type": "integer", "description": "End range port (or ICMP code if protocol is `icmp`).\n" } }, "type": "object", "required": [ "fromPort", "protocol", "toPort" ], "language": { "nodejs": { "requiredOutputs": [ "description", "fromPort", "protocol", "toPort" ] } } }, "aws:ec2/SpotFleetRequestLaunchSpecification:SpotFleetRequestLaunchSpecification": { "properties": { "ami": { "type": "string", "willReplaceOnChanges": true }, "associatePublicIpAddress": { "type": "boolean" }, "availabilityZone": { "type": "string", "description": "The availability zone in which to place the request.\n", "willReplaceOnChanges": true }, "ebsBlockDevices": { "type": "array", "items": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchSpecificationEbsBlockDevice:SpotFleetRequestLaunchSpecificationEbsBlockDevice" } }, "ebsOptimized": { "type": "boolean" }, "ephemeralBlockDevices": { "type": "array", "items": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchSpecificationEphemeralBlockDevice:SpotFleetRequestLaunchSpecificationEphemeralBlockDevice" }, "willReplaceOnChanges": true }, "iamInstanceProfile": { "type": "string", "willReplaceOnChanges": true }, "iamInstanceProfileArn": { "type": "string", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "The type of instance to request.\n", "willReplaceOnChanges": true }, "keyName": { "type": "string", "willReplaceOnChanges": true }, "monitoring": { "type": "boolean" }, "placementGroup": { "type": "string", "willReplaceOnChanges": true }, "placementTenancy": { "type": "string", "willReplaceOnChanges": true }, "rootBlockDevices": { "type": "array", "items": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchSpecificationRootBlockDevice:SpotFleetRequestLaunchSpecificationRootBlockDevice" } }, "spotPrice": { "type": "string", "description": "The maximum bid price per unit hour.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The subnet in which to launch the requested instance.\n", "willReplaceOnChanges": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags to assign to the resource. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n", "willReplaceOnChanges": true }, "userData": { "type": "string", "willReplaceOnChanges": true }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" } }, "weightedCapacity": { "type": "string", "description": "The capacity added to the fleet by a fulfilled request.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "ami", "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ami", "availabilityZone", "ebsBlockDevices", "ephemeralBlockDevices", "instanceType", "keyName", "placementGroup", "rootBlockDevices", "subnetId", "vpcSecurityGroupIds" ] } } }, "aws:ec2/SpotFleetRequestLaunchSpecificationEbsBlockDevice:SpotFleetRequestLaunchSpecificationEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "willReplaceOnChanges": true }, "deviceName": { "type": "string", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "willReplaceOnChanges": true }, "iops": { "type": "integer", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "kmsKeyId", "snapshotId", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/SpotFleetRequestLaunchSpecificationEphemeralBlockDevice:SpotFleetRequestLaunchSpecificationEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string" }, "virtualName": { "type": "string" } }, "type": "object", "required": [ "deviceName", "virtualName" ] }, "aws:ec2/SpotFleetRequestLaunchSpecificationRootBlockDevice:SpotFleetRequestLaunchSpecificationRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "willReplaceOnChanges": true }, "iops": { "type": "integer", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "encrypted", "iops", "kmsKeyId", "throughput", "volumeSize", "volumeType" ] } } }, "aws:ec2/SpotFleetRequestLaunchTemplateConfig:SpotFleetRequestLaunchTemplateConfig": { "properties": { "launchTemplateSpecification": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigLaunchTemplateSpecification:SpotFleetRequestLaunchTemplateConfigLaunchTemplateSpecification", "description": "Launch template specification. See Launch Template Specification below for more details.\n" }, "overrides": { "type": "array", "items": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverride:SpotFleetRequestLaunchTemplateConfigOverride" }, "description": "One or more override configurations. See Overrides below for more details.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "launchTemplateSpecification" ] }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigLaunchTemplateSpecification:SpotFleetRequestLaunchTemplateConfigLaunchTemplateSpecification": { "properties": { "id": { "type": "string", "description": "The ID of the launch template. Conflicts with `name`.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the launch template. Conflicts with `id`.\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "Template version. Unlike the autoscaling equivalent, does not support `$Latest` or `$Default`, so use the launch_template resource's attribute, e.g., `\"${aws_launch_template.foo.latest_version}\"`. It will use the default version if omitted.\n\n**Note:** The specified launch template can specify only a subset of the\ninputs of `aws.ec2.LaunchTemplate`. There are limitations on\nwhat you can specify as spot fleet does not support all the attributes that are supported by autoscaling groups. [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#launch-templates-spot-fleet) is currently sparse, but at least `instance_initiated_shutdown_behavior` is confirmed unsupported.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverride:SpotFleetRequestLaunchTemplateConfigOverride": { "properties": { "availabilityZone": { "type": "string", "description": "The availability zone in which to place the request.\n", "willReplaceOnChanges": true }, "instanceRequirements": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirements:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirements", "description": "The instance requirements. See below.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "The type of instance to request.\n", "willReplaceOnChanges": true }, "priority": { "type": "number", "description": "The priority for the launch template override. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority.\n", "willReplaceOnChanges": true }, "spotPrice": { "type": "string", "description": "The maximum spot bid for this override request.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The subnet in which to launch the requested instance.\n", "willReplaceOnChanges": true }, "weightedCapacity": { "type": "number", "description": "The capacity added to the fleet by a fulfilled request.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "priority", "spotPrice", "subnetId", "weightedCapacity" ] } } }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirements:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirements": { "properties": { "acceleratorCount": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount", "description": "Block describing the minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips). Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator manufacturer names. Default is any manufacturer.\n\n```\nValid names:\n* amazon-web-services\n* amd\n* nvidia\n* xilinx\n```\n", "willReplaceOnChanges": true }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator names. Default is any acclerator.\n\n```\nValid names:\n* a100 - NVIDIA A100 GPUs\n* v100 - NVIDIA V100 GPUs\n* k80 - NVIDIA K80 GPUs\n* t4 - NVIDIA T4 GPUs\n* m60 - NVIDIA M60 GPUs\n* radeon-pro-v520 - AMD Radeon Pro V520 GPUs\n* vu9p - Xilinx VU9P FPGAs\n```\n", "willReplaceOnChanges": true }, "acceleratorTotalMemoryMib": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib", "description": "Block describing the minimum and maximum total memory of the accelerators. Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "List of accelerator types. Default is any accelerator type.\n\n```\nValid types:\n* fpga\n* gpu\n* inference\n```\n", "willReplaceOnChanges": true }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. 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*`. For example, if you specify `c5*`, you are allowing the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, you are allowing all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is all instance types.\n\n\u003e **NOTE:** If you specify `allowed_instance_types`, you can't specify `excluded_instance_types`.\n", "willReplaceOnChanges": true }, "bareMetal": { "type": "string", "description": "Indicate whether bare metal instace types should be `included`, `excluded`, or `required`. Default is `excluded`.\n", "willReplaceOnChanges": true }, "baselineEbsBandwidthMbps": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps", "description": "Block describing the minimum and maximum baseline EBS bandwidth, in Mbps. Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "burstablePerformance": { "type": "string", "description": "Indicate whether burstable performance instance types should be `included`, `excluded`, or `required`. Default is `excluded`.\n", "willReplaceOnChanges": true }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "List of CPU manufacturer names. Default is any manufacturer.\n\n\u003e **NOTE:** 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\n```\nValid names:\n* amazon-web-services\n* amd\n* intel\n```\n", "willReplaceOnChanges": true }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to exclude. 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*`. 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.*`, you are excluding all the M5a instance types, but not the M5n instance types. Maximum of 400 entries in the list; each entry is limited to 30 characters. Default is no excluded instance types.\n\n\u003e **NOTE:** If you specify `excluded_instance_types`, you can't specify `allowed_instance_types`.\n", "willReplaceOnChanges": true }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "List of instance generation names. Default is any generation.\n\n```\nValid names:\n* current - Recommended for best performance.\n* previous - For existing applications optimized for older instance types.\n```\n", "willReplaceOnChanges": true }, "localStorage": { "type": "string", "description": "Indicate whether instance types with local storage volumes are `included`, `excluded`, or `required`. Default is `included`.\n", "willReplaceOnChanges": true }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "List of local storage type names. Default any storage type.\n\n```\nValue names:\n* hdd - hard disk drive\n* ssd - solid state drive\n```\n", "willReplaceOnChanges": true }, "memoryGibPerVcpu": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu", "description": "Block describing the minimum and maximum amount of memory (GiB) per vCPU. Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "memoryMib": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib", "description": "Block describing the minimum and maximum amount of memory (MiB). Default is no maximum.\n", "willReplaceOnChanges": true }, "networkBandwidthGbps": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps", "description": "Block describing the minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "networkInterfaceCount": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount", "description": "Block describing the minimum and maximum number of network interfaces. Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 20.\n\nIf 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", "willReplaceOnChanges": true }, "requireHibernateSupport": { "type": "boolean", "description": "Indicate whether instance types must support On-Demand Instance Hibernation, either `true` or `false`. Default is `false`.\n", "willReplaceOnChanges": true }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. Default is 100.\n\nIf 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", "willReplaceOnChanges": true }, "totalLocalStorageGb": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb", "description": "Block describing the minimum and maximum total local storage (GB). Default is no minimum or maximum.\n", "willReplaceOnChanges": true }, "vcpuCount": { "$ref": "#/types/aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount", "description": "Block describing the minimum and maximum number of vCPUs. Default is no maximum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorCount": { "properties": { "max": { "type": "integer", "description": "Maximum. Set to `0` to exclude instance types with accelerators.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsBaselineEbsBandwidthMbps": { "properties": { "max": { "type": "integer", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryGibPerVcpu": { "properties": { "max": { "type": "number", "description": "Maximum. May be a decimal number, e.g. `0.5`.\n", "willReplaceOnChanges": true }, "min": { "type": "number", "description": "Minimum. May be a decimal number, e.g. `0.5`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsMemoryMib": { "properties": { "max": { "type": "integer", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkBandwidthGbps": { "properties": { "max": { "type": "number", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "number", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsNetworkInterfaceCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsTotalLocalStorageGb": { "properties": { "max": { "type": "number", "description": "Maximum. May be a decimal number, e.g. `0.5`.\n", "willReplaceOnChanges": true }, "min": { "type": "number", "description": "Minimum. May be a decimal number, e.g. `0.5`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount:SpotFleetRequestLaunchTemplateConfigOverrideInstanceRequirementsVcpuCount": { "properties": { "max": { "type": "integer", "description": "Maximum.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "Minimum.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotFleetRequestSpotMaintenanceStrategies:SpotFleetRequestSpotMaintenanceStrategies": { "properties": { "capacityRebalance": { "$ref": "#/types/aws:ec2/SpotFleetRequestSpotMaintenanceStrategiesCapacityRebalance:SpotFleetRequestSpotMaintenanceStrategiesCapacityRebalance", "description": "Nested argument containing the capacity rebalance for your fleet request. Defined below.\n" } }, "type": "object" }, "aws:ec2/SpotFleetRequestSpotMaintenanceStrategiesCapacityRebalance:SpotFleetRequestSpotMaintenanceStrategiesCapacityRebalance": { "properties": { "replacementStrategy": { "type": "string", "description": "The replacement strategy to use. Only available for spot fleets with `fleet_type` set to `maintain`. Valid values: `launch`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/SpotInstanceRequestCapacityReservationSpecification:SpotInstanceRequestCapacityReservationSpecification": { "properties": { "capacityReservationPreference": { "type": "string", "description": "Indicates the instance's Capacity Reservation preferences. Can be `\"open\"` or `\"none\"`. (Default: `\"open\"`).\n" }, "capacityReservationTarget": { "$ref": "#/types/aws:ec2/SpotInstanceRequestCapacityReservationSpecificationCapacityReservationTarget:SpotInstanceRequestCapacityReservationSpecificationCapacityReservationTarget", "description": "Information about the target Capacity Reservation. See Capacity Reservation Target below for more details.\n\nFor more information, see the documentation on [Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html).\n" } }, "type": "object" }, "aws:ec2/SpotInstanceRequestCapacityReservationSpecificationCapacityReservationTarget:SpotInstanceRequestCapacityReservationSpecificationCapacityReservationTarget": { "properties": { "capacityReservationId": { "type": "string", "description": "ID of the Capacity Reservation in which to run the instance.\n" }, "capacityReservationResourceGroupArn": { "type": "string", "description": "ARN of the Capacity Reservation resource group in which to run the instance.\n" } }, "type": "object" }, "aws:ec2/SpotInstanceRequestCpuOptions:SpotInstanceRequestCpuOptions": { "properties": { "amdSevSnp": { "type": "string", "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. Valid values are `enabled` and `disabled`.\n", "willReplaceOnChanges": true }, "coreCount": { "type": "integer", "description": "Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options [CPU Cores and Threads Per CPU Core Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#cpu-options-supported-instances-values) - specifying this option for unsupported instance types will return an error from the EC2 API.\n", "willReplaceOnChanges": true }, "threadsPerCore": { "type": "integer", "description": "If set to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) for more information.\n\nFor more information, see the documentation on [Optimizing CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amdSevSnp", "coreCount", "threadsPerCore" ] } } }, "aws:ec2/SpotInstanceRequestCreditSpecification:SpotInstanceRequestCreditSpecification": { "properties": { "cpuCredits": { "type": "string", "description": "Credit option for CPU usage. Valid values include `standard` or `unlimited`. T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.\n" } }, "type": "object" }, "aws:ec2/SpotInstanceRequestEbsBlockDevice:SpotInstanceRequestEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the volume should be destroyed on instance termination. Defaults to `true`.\n", "willReplaceOnChanges": true }, "deviceName": { "type": "string", "description": "Name of the device to mount.\n", "willReplaceOnChanges": true }, "encrypted": { "type": "boolean", "description": "Enables [EBS encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) on the volume. Defaults to `false`. Cannot be used with `snapshot_id`. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Amount of provisioned [IOPS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html). Only valid for volume_type of `io1`, `io2` or `gp3`.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS Key to use when encrypting the volume. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "description": "Snapshot ID to mount.\n", "willReplaceOnChanges": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assign to the device.\n" }, "tagsAll": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.\n" }, "throughput": { "type": "integer", "description": "Throughput to provision for a volume in mebibytes per second (MiB/s). This is only valid for `volume_type` of `gp3`.\n", "willReplaceOnChanges": true }, "volumeId": { "type": "string" }, "volumeSize": { "type": "integer", "description": "Size of the volume in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "Type of volume. Valid values include `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1`, or `st1`. Defaults to `gp2`.\n\n\u003e **NOTE:** Currently, changes to the `ebs_block_device` configuration of _existing_ resources cannot be automatically detected by this provider. To manage changes and attachments of an EBS block to an instance, use the `aws.ebs.Volume` and `aws.ec2.VolumeAttachment` resources instead. If you use `ebs_block_device` on an `aws.ec2.Instance`, this provider will assume management over the full set of non-root EBS block devices for the instance, treating additional block devices as drift. For this reason, `ebs_block_device` cannot be mixed with external `aws.ebs.Volume` and `aws.ec2.VolumeAttachment` resources for a given instance.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "kmsKeyId", "snapshotId", "tagsAll", "throughput", "volumeId", "volumeSize", "volumeType" ] } } }, "aws:ec2/SpotInstanceRequestEnclaveOptions:SpotInstanceRequestEnclaveOptions": { "properties": { "enabled": { "type": "boolean", "description": "Whether Nitro Enclaves will be enabled on the instance. Defaults to `false`.\n\nFor more information, see the documentation on [Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:ec2/SpotInstanceRequestEphemeralBlockDevice:SpotInstanceRequestEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Name of the block device to mount on the instance.\n" }, "noDevice": { "type": "boolean", "description": "Suppresses the specified device included in the AMI's block device mapping.\n" }, "virtualName": { "type": "string", "description": "[Instance Store Device Name](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#InstanceStoreDeviceNames) (e.g., `ephemeral0`).\n\nEach AWS Instance type has a different set of Instance Store block devices available for attachment. AWS [publishes a list](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#StorageOnInstanceTypes) of which ephemeral devices are available on each type. The devices are always identified by the `virtual_name` in the format `ephemeral{0..N}`.\n" } }, "type": "object", "required": [ "deviceName" ] }, "aws:ec2/SpotInstanceRequestLaunchTemplate:SpotInstanceRequestLaunchTemplate": { "properties": { "id": { "type": "string", "description": "ID of the launch template. Conflicts with `name`.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the launch template. Conflicts with `id`.\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "Template version. Can be a specific version number, `$Latest` or `$Default`. The default value is `$Default`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "name" ] } } }, "aws:ec2/SpotInstanceRequestMaintenanceOptions:SpotInstanceRequestMaintenanceOptions": { "properties": { "autoRecovery": { "type": "string", "description": "Automatic recovery behavior of the Instance. Can be `\"default\"` or `\"disabled\"`. See [Recover your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html) for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRecovery" ] } } }, "aws:ec2/SpotInstanceRequestMetadataOptions:SpotInstanceRequestMetadataOptions": { "properties": { "httpEndpoint": { "type": "string", "description": "Whether the metadata service is available. Valid values include `enabled` or `disabled`. Defaults to `enabled`.\n" }, "httpProtocolIpv6": { "type": "string", "description": "Whether the IPv6 endpoint for the instance metadata service is enabled. Defaults to `disabled`.\n" }, "httpPutResponseHopLimit": { "type": "integer", "description": "Desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Valid values are integer from `1` to `64`. Defaults to `1`.\n" }, "httpTokens": { "type": "string", "description": "Whether or not the metadata service requires session tokens, also referred to as _Instance Metadata Service Version 2 (IMDSv2)_. Valid values include `optional` or `required`.\n" }, "instanceMetadataTags": { "type": "string", "description": "Enables or disables access to instance tags from the instance metadata service. Valid values include `enabled` or `disabled`. Defaults to `disabled`.\n\nFor more information, see the documentation on the [Instance Metadata Service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "httpPutResponseHopLimit", "httpTokens", "instanceMetadataTags" ] } } }, "aws:ec2/SpotInstanceRequestNetworkInterface:SpotInstanceRequestNetworkInterface": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether or not to delete the network interface on instance termination. Defaults to `false`. Currently, the only valid value is `false`, as this is only supported when creating new network interfaces when launching an instance.\n", "willReplaceOnChanges": true }, "deviceIndex": { "type": "integer", "description": "Integer index of the network interface attachment. Limited by instance type.\n", "willReplaceOnChanges": true }, "networkCardIndex": { "type": "integer", "description": "Integer index of the network card. Limited by instance type. The default index is `0`.\n", "willReplaceOnChanges": true }, "networkInterfaceId": { "type": "string", "description": "ID of the network interface to attach.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceIndex", "networkInterfaceId" ] }, "aws:ec2/SpotInstanceRequestPrivateDnsNameOptions:SpotInstanceRequestPrivateDnsNameOptions": { "properties": { "enableResourceNameDnsARecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n" }, "enableResourceNameDnsAaaaRecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n" }, "hostnameType": { "type": "string", "description": "Type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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. Valid values: `ip-name` and `resource-name`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableResourceNameDnsARecord", "enableResourceNameDnsAaaaRecord", "hostnameType" ] } } }, "aws:ec2/SpotInstanceRequestRootBlockDevice:SpotInstanceRequestRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the volume should be destroyed on instance termination. Defaults to `true`.\n" }, "deviceName": { "type": "string" }, "encrypted": { "type": "boolean", "description": "Whether to enable volume encryption. Defaults to `false`. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Amount of provisioned [IOPS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html). Only valid for volume_type of `io1`, `io2` or `gp3`.\n" }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS Key to use when encrypting the volume. Must be configured to perform drift detection.\n", "willReplaceOnChanges": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assign to the device.\n" }, "tagsAll": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.\n" }, "throughput": { "type": "integer", "description": "Throughput to provision for a volume in mebibytes per second (MiB/s). This is only valid for `volume_type` of `gp3`.\n" }, "volumeId": { "type": "string" }, "volumeSize": { "type": "integer", "description": "Size of the volume in gibibytes (GiB).\n" }, "volumeType": { "type": "string", "description": "Type of volume. Valid values include `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1`, or `st1`. Defaults to the volume type that the AMI uses.\n\nModifying the `encrypted` or `kms_key_id` settings of the `root_block_device` requires resource replacement.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deviceName", "encrypted", "iops", "kmsKeyId", "tagsAll", "throughput", "volumeId", "volumeSize", "volumeType" ] } } }, "aws:ec2/Tenancy:Tenancy": { "type": "string", "enum": [ { "name": "Default", "value": "default" }, { "name": "Dedicated", "value": "dedicated" } ] }, "aws:ec2/TrafficMirrorFilterRuleDestinationPortRange:TrafficMirrorFilterRuleDestinationPortRange": { "properties": { "fromPort": { "type": "integer", "description": "Starting port of the range\n" }, "toPort": { "type": "integer", "description": "Ending port of the range\n" } }, "type": "object" }, "aws:ec2/TrafficMirrorFilterRuleSourcePortRange:TrafficMirrorFilterRuleSourcePortRange": { "properties": { "fromPort": { "type": "integer", "description": "Starting port of the range\n" }, "toPort": { "type": "integer", "description": "Ending port of the range\n" } }, "type": "object" }, "aws:ec2/VpcBlockPublicAccessExclusionTimeouts:VpcBlockPublicAccessExclusionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2/VpcBlockPublicAccessOptionsTimeouts:VpcBlockPublicAccessOptionsTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2/VpcEndpointDnsEntry:VpcEndpointDnsEntry": { "properties": { "dnsName": { "type": "string", "description": "The DNS name.\n" }, "hostedZoneId": { "type": "string", "description": "The ID of the private hosted zone.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "hostedZoneId" ] } } }, "aws:ec2/VpcEndpointDnsOptions:VpcEndpointDnsOptions": { "properties": { "dnsRecordIpType": { "type": "string", "description": "The DNS records created for the endpoint. Valid values are `ipv4`, `dualstack`, `service-defined`, and `ipv6`.\n" }, "privateDnsOnlyForInboundResolverEndpoint": { "type": "boolean", "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. Default is `false`. Can only be specified if private_dns_enabled is `true`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsRecordIpType" ] } } }, "aws:ec2/VpcEndpointServicePrivateDnsNameConfiguration:VpcEndpointServicePrivateDnsNameConfiguration": { "properties": { "name": { "type": "string", "description": "Name of the record subdomain the service provider needs to create.\n" }, "state": { "type": "string", "description": "Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is `verified`.\n" }, "type": { "type": "string", "description": "Endpoint service verification type, for example `TXT`.\n" }, "value": { "type": "string", "description": "Value the service provider adds to the private DNS name domain record before verification.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "state", "type", "value" ] } } }, "aws:ec2/VpcEndpointSubnetConfiguration:VpcEndpointSubnetConfiguration": { "properties": { "ipv4": { "type": "string", "description": "The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4.\n" }, "ipv6": { "type": "string", "description": "The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6.\n" }, "subnetId": { "type": "string" } }, "type": "object" }, "aws:ec2/VpcIpamOperatingRegion:VpcIpamOperatingRegion": { "properties": { "regionName": { "type": "string", "description": "The name of the Region you want to add to the IPAM.\n" } }, "type": "object", "required": [ "regionName" ] }, "aws:ec2/VpcIpamPoolCidrCidrAuthorizationContext:VpcIpamPoolCidrCidrAuthorizationContext": { "properties": { "message": { "type": "string", "description": "The plain-text authorization message for the prefix and account.\n", "willReplaceOnChanges": true }, "signature": { "type": "string", "description": "The signed authorization message for the prefix and account.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2/VpcIpamResourceDiscoveryOperatingRegion:VpcIpamResourceDiscoveryOperatingRegion": { "properties": { "regionName": { "type": "string", "description": "The name of the Region you want to add to the IPAM.\n" } }, "type": "object", "required": [ "regionName" ] }, "aws:ec2/VpcPeeringConnectionAccepter:VpcPeeringConnectionAccepter": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Allow a local VPC to resolve public DNS hostnames to\nprivate IP addresses when queried from instances in the peer VPC.\n" } }, "type": "object" }, "aws:ec2/VpcPeeringConnectionAccepterAccepter:VpcPeeringConnectionAccepterAccepter": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Indicates whether a local VPC can resolve public DNS hostnames to\nprivate IP addresses when queried from instances in a peer VPC.\n" } }, "type": "object" }, "aws:ec2/VpcPeeringConnectionAccepterRequester:VpcPeeringConnectionAccepterRequester": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Indicates whether a local VPC can resolve public DNS hostnames to\nprivate IP addresses when queried from instances in a peer VPC.\n" } }, "type": "object" }, "aws:ec2/VpcPeeringConnectionRequester:VpcPeeringConnectionRequester": { "properties": { "allowRemoteVpcDnsResolution": { "type": "boolean", "description": "Allow a local VPC to resolve public DNS hostnames to\nprivate IP addresses when queried from instances in the peer VPC.\n" } }, "type": "object" }, "aws:ec2/VpnConnectionRoute:VpnConnectionRoute": { "properties": { "destinationCidrBlock": { "type": "string", "description": "The CIDR block associated with the local subnet of the customer data center.\n" }, "source": { "type": "string", "description": "Indicates how the routes were provided.\n" }, "state": { "type": "string", "description": "The current state of the static route.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationCidrBlock", "source", "state" ] } } }, "aws:ec2/VpnConnectionTunnel1LogOptions:VpnConnectionTunnel1LogOptions": { "properties": { "cloudwatchLogOptions": { "$ref": "#/types/aws:ec2/VpnConnectionTunnel1LogOptionsCloudwatchLogOptions:VpnConnectionTunnel1LogOptionsCloudwatchLogOptions", "description": "Options for sending VPN tunnel logs to CloudWatch. See CloudWatch Log Options below for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLogOptions" ] } } }, "aws:ec2/VpnConnectionTunnel1LogOptionsCloudwatchLogOptions:VpnConnectionTunnel1LogOptionsCloudwatchLogOptions": { "properties": { "logEnabled": { "type": "boolean", "description": "Enable or disable VPN tunnel logging feature. The default is `false`.\n" }, "logGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.\n" }, "logOutputFormat": { "type": "string", "description": "Set log format. Default format is json. Possible values are: `json` and `text`. The default is `json`.\n" } }, "type": "object" }, "aws:ec2/VpnConnectionTunnel2LogOptions:VpnConnectionTunnel2LogOptions": { "properties": { "cloudwatchLogOptions": { "$ref": "#/types/aws:ec2/VpnConnectionTunnel2LogOptionsCloudwatchLogOptions:VpnConnectionTunnel2LogOptionsCloudwatchLogOptions", "description": "Options for sending VPN tunnel logs to CloudWatch. See CloudWatch Log Options below for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLogOptions" ] } } }, "aws:ec2/VpnConnectionTunnel2LogOptionsCloudwatchLogOptions:VpnConnectionTunnel2LogOptionsCloudwatchLogOptions": { "properties": { "logEnabled": { "type": "boolean", "description": "Enable or disable VPN tunnel logging feature. The default is `false`.\n" }, "logGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.\n" }, "logOutputFormat": { "type": "string", "description": "Set log format. Default format is json. Possible values are: `json` and `text`. The default is `json`.\n" } }, "type": "object" }, "aws:ec2/VpnConnectionVgwTelemetry:VpnConnectionVgwTelemetry": { "properties": { "acceptedRouteCount": { "type": "integer", "description": "The number of accepted routes.\n" }, "certificateArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.\n" }, "lastStatusChange": { "type": "string", "description": "The date and time of the last change in status.\n" }, "outsideIpAddress": { "type": "string", "description": "The Internet-routable IP address of the virtual private gateway's outside interface.\n" }, "status": { "type": "string", "description": "The status of the VPN tunnel.\n" }, "statusMessage": { "type": "string", "description": "If an error occurs, a description of the error.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "acceptedRouteCount", "certificateArn", "lastStatusChange", "outsideIpAddress", "status", "statusMessage" ] } } }, "aws:ec2/getAmiBlockDeviceMapping:getAmiBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "Physical name of the device.\n" }, "ebs": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., `ebs.volume_size` or `ebs[\"volume_size\"]`) rather than accessed through the first element of a list (e.g., `ebs[0].volume_size`).\n" }, "noDevice": { "type": "string", "description": "Suppresses the specified device included in the block device mapping of the AMI.\n" }, "virtualName": { "type": "string", "description": "Virtual device name (for instance stores).\n" } }, "type": "object", "required": [ "deviceName", "ebs", "noDevice", "virtualName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getAmiFilter:getAmiFilter": { "properties": { "name": { "type": "string", "description": "Name of the AMI that was provided during image creation.\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getAmiIdsFilter:getAmiIdsFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getAmiProductCode:getAmiProductCode": { "properties": { "productCodeId": { "type": "string" }, "productCodeType": { "type": "string" } }, "type": "object", "required": [ "productCodeId", "productCodeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getCoipPoolFilter:getCoipPoolFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCoipPools.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA COIP Pool will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getCoipPoolsFilter:getCoipPoolsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCoipPools.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA COIP Pool will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getCustomerGatewayFilter:getCustomerGatewayFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getDedicatedHostFilter:getDedicatedHostFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeHosts.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getEipsFilter:getEipsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. An Elastic IP will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getElasticIpFilter:getElasticIpFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInstanceCreditSpecification:getInstanceCreditSpecification": { "properties": { "cpuCredits": { "type": "string" } }, "type": "object", "required": [ "cpuCredits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceEbsBlockDevice:getInstanceEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "If the root block device will be deleted on termination.\n" }, "deviceName": { "type": "string", "description": "Physical name of the device.\n" }, "encrypted": { "type": "boolean", "description": "If the EBS volume is encrypted.\n" }, "iops": { "type": "integer", "description": "`0` If the volume is not a provisioned IOPS image, otherwise the supported IOPS count.\n" }, "kmsKeyId": { "type": "string" }, "snapshotId": { "type": "string", "description": "ID of the snapshot.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags assigned to the Instance.\n" }, "throughput": { "type": "integer", "description": "Throughput of the volume, in MiB/s.\n" }, "volumeId": { "type": "string" }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n" }, "volumeType": { "type": "string", "description": "Type of the volume.\n" } }, "type": "object", "required": [ "deleteOnTermination", "deviceName", "encrypted", "iops", "kmsKeyId", "snapshotId", "tags", "throughput", "volumeId", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceEnclaveOption:getInstanceEnclaveOption": { "properties": { "enabled": { "type": "boolean", "description": "Whether Nitro Enclaves are enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceEphemeralBlockDevice:getInstanceEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Physical name of the device.\n" }, "noDevice": { "type": "boolean", "description": "Whether the specified device included in the device mapping was suppressed or not (Boolean).\n" }, "virtualName": { "type": "string", "description": "Virtual device name.\n" } }, "type": "object", "required": [ "deviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceFilter:getInstanceFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInstanceMaintenanceOption:getInstanceMaintenanceOption": { "properties": { "autoRecovery": { "type": "string", "description": "Automatic recovery behavior of the instance.\n" } }, "type": "object", "required": [ "autoRecovery" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceMetadataOption:getInstanceMetadataOption": { "properties": { "httpEndpoint": { "type": "string", "description": "State of the metadata service: `enabled`, `disabled`.\n" }, "httpProtocolIpv6": { "type": "string", "description": "Whether the IPv6 endpoint for the instance metadata service is `enabled` or `disabled`\n" }, "httpPutResponseHopLimit": { "type": "integer", "description": "Desired HTTP PUT response hop limit for instance metadata requests.\n" }, "httpTokens": { "type": "string", "description": "If session tokens are required: `optional`, `required`.\n" }, "instanceMetadataTags": { "type": "string", "description": "If access to instance tags is allowed from the metadata service: `enabled`, `disabled`.\n" } }, "type": "object", "required": [ "httpEndpoint", "httpProtocolIpv6", "httpPutResponseHopLimit", "httpTokens", "instanceMetadataTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstancePrivateDnsNameOption:getInstancePrivateDnsNameOption": { "properties": { "enableResourceNameDnsARecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n" }, "enableResourceNameDnsAaaaRecord": { "type": "boolean", "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n" }, "hostnameType": { "type": "string", "description": "Type of hostname for EC2 instances.\n" } }, "type": "object", "required": [ "enableResourceNameDnsARecord", "enableResourceNameDnsAaaaRecord", "hostnameType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceRootBlockDevice:getInstanceRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "If the root block device will be deleted on termination.\n" }, "deviceName": { "type": "string", "description": "Physical name of the device.\n" }, "encrypted": { "type": "boolean", "description": "If the EBS volume is encrypted.\n" }, "iops": { "type": "integer", "description": "`0` If the volume is not a provisioned IOPS image, otherwise the supported IOPS count.\n" }, "kmsKeyId": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags assigned to the Instance.\n" }, "throughput": { "type": "integer", "description": "Throughput of the volume, in MiB/s.\n" }, "volumeId": { "type": "string" }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n" }, "volumeType": { "type": "string", "description": "Type of the volume.\n" } }, "type": "object", "required": [ "deleteOnTermination", "deviceName", "encrypted", "iops", "kmsKeyId", "tags", "throughput", "volumeId", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeFpga:getInstanceTypeFpga": { "properties": { "count": { "type": "integer" }, "manufacturer": { "type": "string" }, "memorySize": { "type": "integer", "description": "Size of the instance memory, in MiB.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "count", "manufacturer", "memorySize", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeGpus:getInstanceTypeGpus": { "properties": { "count": { "type": "integer" }, "manufacturer": { "type": "string" }, "memorySize": { "type": "integer", "description": "Size of the instance memory, in MiB.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "count", "manufacturer", "memorySize", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeInferenceAccelerator:getInstanceTypeInferenceAccelerator": { "properties": { "count": { "type": "integer" }, "manufacturer": { "type": "string" }, "memorySize": { "type": "integer", "description": "Size of the instance memory, in MiB.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "count", "manufacturer", "memorySize", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeInstanceDisk:getInstanceTypeInstanceDisk": { "properties": { "count": { "type": "integer" }, "size": { "type": "integer" }, "type": { "type": "string" } }, "type": "object", "required": [ "count", "size", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeMediaAccelerator:getInstanceTypeMediaAccelerator": { "properties": { "count": { "type": "integer" }, "manufacturer": { "type": "string" }, "memorySize": { "type": "integer", "description": "Size of the instance memory, in MiB.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "count", "manufacturer", "memorySize", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeNetworkCard:getInstanceTypeNetworkCard": { "properties": { "baselineBandwidth": { "type": "number" }, "index": { "type": "integer" }, "maximumInterfaces": { "type": "integer" }, "peakBandwidth": { "type": "number" }, "performance": { "type": "string" } }, "type": "object", "required": [ "baselineBandwidth", "index", "maximumInterfaces", "peakBandwidth", "performance" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeNeuronDevice:getInstanceTypeNeuronDevice": { "properties": { "coreCount": { "type": "integer" }, "coreVersion": { "type": "integer" }, "count": { "type": "integer" }, "memorySize": { "type": "integer", "description": "Size of the instance memory, in MiB.\n" }, "name": { "type": "string" } }, "type": "object", "required": [ "coreCount", "coreVersion", "count", "memorySize", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInstanceTypeOfferingFilter:getInstanceTypeOfferingFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter. The `location` filter depends on the top-level `location_type` argument and if not specified, defaults to the current region.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInstanceTypeOfferingsFilter:getInstanceTypeOfferingsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter. The `location` filter depends on the top-level `location_type` argument and if not specified, defaults to the current region.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInstanceTypesFilter:getInstanceTypesFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInstancesFilter:getInstancesFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getInternetGatewayAttachment:getInternetGatewayAttachment": { "properties": { "state": { "type": "string", "description": "Current state of the attachment between the gateway and the VPC. Present only if a VPC is attached\n" }, "vpcId": { "type": "string", "description": "ID of an attached VPC.\n" } }, "type": "object", "required": [ "state", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getInternetGatewayFilter:getInternetGatewayFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nAn Internet Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getKeyPairFilter:getKeyPairFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeKeyPairs API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeKeyPairs.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLaunchConfigurationEbsBlockDevice:getLaunchConfigurationEbsBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the EBS Volume will be deleted on instance termination.\n" }, "deviceName": { "type": "string", "description": "Name of the device.\n" }, "encrypted": { "type": "boolean", "description": "Whether the volume is Encrypted.\n" }, "iops": { "type": "integer", "description": "Provisioned IOPs of the volume.\n" }, "noDevice": { "type": "boolean", "description": "Whether the device in the block device mapping of the AMI is suppressed.\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID of the mount.\n" }, "throughput": { "type": "integer", "description": "Throughput of the volume.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume.\n" }, "volumeType": { "type": "string", "description": "Type of the volume.\n" } }, "type": "object", "required": [ "deleteOnTermination", "deviceName", "encrypted", "iops", "noDevice", "snapshotId", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchConfigurationEphemeralBlockDevice:getLaunchConfigurationEphemeralBlockDevice": { "properties": { "deviceName": { "type": "string", "description": "Name of the device.\n" }, "virtualName": { "type": "string", "description": "Virtual Name of the device.\n" } }, "type": "object", "required": [ "deviceName", "virtualName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchConfigurationMetadataOption:getLaunchConfigurationMetadataOption": { "properties": { "httpEndpoint": { "type": "string", "description": "State of the metadata service: `enabled`, `disabled`.\n" }, "httpPutResponseHopLimit": { "type": "integer", "description": "The desired HTTP PUT response hop limit for instance metadata requests.\n" }, "httpTokens": { "type": "string", "description": "If session tokens are required: `optional`, `required`.\n" } }, "type": "object", "required": [ "httpEndpoint", "httpPutResponseHopLimit", "httpTokens" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchConfigurationRootBlockDevice:getLaunchConfigurationRootBlockDevice": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether the EBS Volume will be deleted on instance termination.\n" }, "encrypted": { "type": "boolean", "description": "Whether the volume is Encrypted.\n" }, "iops": { "type": "integer", "description": "Provisioned IOPs of the volume.\n" }, "throughput": { "type": "integer", "description": "Throughput of the volume.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume.\n" }, "volumeType": { "type": "string", "description": "Type of the volume.\n" } }, "type": "object", "required": [ "deleteOnTermination", "encrypted", "iops", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateBlockDeviceMapping:getLaunchTemplateBlockDeviceMapping": { "properties": { "deviceName": { "type": "string" }, "ebs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateBlockDeviceMappingEb:getLaunchTemplateBlockDeviceMappingEb" } }, "noDevice": { "type": "string" }, "virtualName": { "type": "string" } }, "type": "object", "required": [ "deviceName", "ebs", "noDevice", "virtualName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateBlockDeviceMappingEb:getLaunchTemplateBlockDeviceMappingEb": { "properties": { "deleteOnTermination": { "type": "string" }, "encrypted": { "type": "string" }, "iops": { "type": "integer" }, "kmsKeyId": { "type": "string" }, "snapshotId": { "type": "string" }, "throughput": { "type": "integer" }, "volumeSize": { "type": "integer" }, "volumeType": { "type": "string" } }, "type": "object", "required": [ "deleteOnTermination", "encrypted", "iops", "kmsKeyId", "snapshotId", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateCapacityReservationSpecification:getLaunchTemplateCapacityReservationSpecification": { "properties": { "capacityReservationPreference": { "type": "string" }, "capacityReservationTargets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateCapacityReservationSpecificationCapacityReservationTarget:getLaunchTemplateCapacityReservationSpecificationCapacityReservationTarget" } } }, "type": "object", "required": [ "capacityReservationPreference", "capacityReservationTargets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateCapacityReservationSpecificationCapacityReservationTarget:getLaunchTemplateCapacityReservationSpecificationCapacityReservationTarget": { "properties": { "capacityReservationId": { "type": "string" }, "capacityReservationResourceGroupArn": { "type": "string" } }, "type": "object", "required": [ "capacityReservationId", "capacityReservationResourceGroupArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateCpuOption:getLaunchTemplateCpuOption": { "properties": { "amdSevSnp": { "type": "string" }, "coreCount": { "type": "integer" }, "threadsPerCore": { "type": "integer" } }, "type": "object", "required": [ "amdSevSnp", "coreCount", "threadsPerCore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateCreditSpecification:getLaunchTemplateCreditSpecification": { "properties": { "cpuCredits": { "type": "string" } }, "type": "object", "required": [ "cpuCredits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateElasticGpuSpecification:getLaunchTemplateElasticGpuSpecification": { "properties": { "type": { "type": "string" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateElasticInferenceAccelerator:getLaunchTemplateElasticInferenceAccelerator": { "properties": { "type": { "type": "string" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateEnclaveOption:getLaunchTemplateEnclaveOption": { "properties": { "enabled": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateFilter:getLaunchTemplateFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeLaunchTemplates API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLaunchTemplateHibernationOption:getLaunchTemplateHibernationOption": { "properties": { "configured": { "type": "boolean" } }, "type": "object", "required": [ "configured" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateIamInstanceProfile:getLaunchTemplateIamInstanceProfile": { "properties": { "arn": { "type": "string" }, "name": { "type": "string", "description": "Name of the launch template.\n" } }, "type": "object", "required": [ "arn", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceMarketOption:getLaunchTemplateInstanceMarketOption": { "properties": { "marketType": { "type": "string" }, "spotOptions": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceMarketOptionSpotOption:getLaunchTemplateInstanceMarketOptionSpotOption" } } }, "type": "object", "required": [ "marketType", "spotOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceMarketOptionSpotOption:getLaunchTemplateInstanceMarketOptionSpotOption": { "properties": { "blockDurationMinutes": { "type": "integer" }, "instanceInterruptionBehavior": { "type": "string" }, "maxPrice": { "type": "string" }, "spotInstanceType": { "type": "string" }, "validUntil": { "type": "string" } }, "type": "object", "required": [ "blockDurationMinutes", "instanceInterruptionBehavior", "maxPrice", "spotInstanceType", "validUntil" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirement:getLaunchTemplateInstanceRequirement": { "properties": { "acceleratorCounts": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementAcceleratorCount:getLaunchTemplateInstanceRequirementAcceleratorCount" } }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" } }, "acceleratorNames": { "type": "array", "items": { "type": "string" } }, "acceleratorTotalMemoryMibs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementAcceleratorTotalMemoryMib:getLaunchTemplateInstanceRequirementAcceleratorTotalMemoryMib" } }, "acceleratorTypes": { "type": "array", "items": { "type": "string" } }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" } }, "bareMetal": { "type": "string" }, "baselineEbsBandwidthMbps": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementBaselineEbsBandwidthMbp:getLaunchTemplateInstanceRequirementBaselineEbsBandwidthMbp" } }, "burstablePerformance": { "type": "string" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" } }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" } }, "instanceGenerations": { "type": "array", "items": { "type": "string" } }, "localStorage": { "type": "string" }, "localStorageTypes": { "type": "array", "items": { "type": "string" } }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer" }, "memoryGibPerVcpus": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementMemoryGibPerVcpus:getLaunchTemplateInstanceRequirementMemoryGibPerVcpus" } }, "memoryMibs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementMemoryMib:getLaunchTemplateInstanceRequirementMemoryMib" } }, "networkBandwidthGbps": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementNetworkBandwidthGbp:getLaunchTemplateInstanceRequirementNetworkBandwidthGbp" } }, "networkInterfaceCounts": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementNetworkInterfaceCount:getLaunchTemplateInstanceRequirementNetworkInterfaceCount" } }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer" }, "requireHibernateSupport": { "type": "boolean" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer" }, "totalLocalStorageGbs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementTotalLocalStorageGb:getLaunchTemplateInstanceRequirementTotalLocalStorageGb" } }, "vcpuCounts": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateInstanceRequirementVcpuCount:getLaunchTemplateInstanceRequirementVcpuCount" } } }, "type": "object", "required": [ "acceleratorCounts", "acceleratorManufacturers", "acceleratorNames", "acceleratorTotalMemoryMibs", "acceleratorTypes", "allowedInstanceTypes", "bareMetal", "baselineEbsBandwidthMbps", "burstablePerformance", "cpuManufacturers", "excludedInstanceTypes", "instanceGenerations", "localStorage", "localStorageTypes", "maxSpotPriceAsPercentageOfOptimalOnDemandPrice", "memoryGibPerVcpus", "memoryMibs", "networkBandwidthGbps", "networkInterfaceCounts", "onDemandMaxPricePercentageOverLowestPrice", "requireHibernateSupport", "spotMaxPricePercentageOverLowestPrice", "totalLocalStorageGbs", "vcpuCounts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementAcceleratorCount:getLaunchTemplateInstanceRequirementAcceleratorCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementAcceleratorTotalMemoryMib:getLaunchTemplateInstanceRequirementAcceleratorTotalMemoryMib": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementBaselineEbsBandwidthMbp:getLaunchTemplateInstanceRequirementBaselineEbsBandwidthMbp": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementMemoryGibPerVcpus:getLaunchTemplateInstanceRequirementMemoryGibPerVcpus": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementMemoryMib:getLaunchTemplateInstanceRequirementMemoryMib": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementNetworkBandwidthGbp:getLaunchTemplateInstanceRequirementNetworkBandwidthGbp": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementNetworkInterfaceCount:getLaunchTemplateInstanceRequirementNetworkInterfaceCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementTotalLocalStorageGb:getLaunchTemplateInstanceRequirementTotalLocalStorageGb": { "properties": { "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateInstanceRequirementVcpuCount:getLaunchTemplateInstanceRequirementVcpuCount": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateLicenseSpecification:getLaunchTemplateLicenseSpecification": { "properties": { "licenseConfigurationArn": { "type": "string" } }, "type": "object", "required": [ "licenseConfigurationArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateMaintenanceOption:getLaunchTemplateMaintenanceOption": { "properties": { "autoRecovery": { "type": "string" } }, "type": "object", "required": [ "autoRecovery" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateMetadataOption:getLaunchTemplateMetadataOption": { "properties": { "httpEndpoint": { "type": "string" }, "httpProtocolIpv6": { "type": "string" }, "httpPutResponseHopLimit": { "type": "integer" }, "httpTokens": { "type": "string" }, "instanceMetadataTags": { "type": "string" } }, "type": "object", "required": [ "httpEndpoint", "httpProtocolIpv6", "httpPutResponseHopLimit", "httpTokens", "instanceMetadataTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateMonitoring:getLaunchTemplateMonitoring": { "properties": { "enabled": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateNetworkInterface:getLaunchTemplateNetworkInterface": { "properties": { "associateCarrierIpAddress": { "type": "string" }, "associatePublicIpAddress": { "type": "boolean" }, "connectionTrackingSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getLaunchTemplateNetworkInterfaceConnectionTrackingSpecification:getLaunchTemplateNetworkInterfaceConnectionTrackingSpecification" } }, "deleteOnTermination": { "type": "boolean" }, "description": { "type": "string" }, "deviceIndex": { "type": "integer" }, "interfaceType": { "type": "string" }, "ipv4AddressCount": { "type": "integer" }, "ipv4Addresses": { "type": "array", "items": { "type": "string" } }, "ipv4PrefixCount": { "type": "integer" }, "ipv4Prefixes": { "type": "array", "items": { "type": "string" } }, "ipv6AddressCount": { "type": "integer" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" } }, "ipv6PrefixCount": { "type": "integer" }, "ipv6Prefixes": { "type": "array", "items": { "type": "string" } }, "networkCardIndex": { "type": "integer" }, "networkInterfaceId": { "type": "string" }, "primaryIpv6": { "type": "string" }, "privateIpAddress": { "type": "string" }, "securityGroups": { "type": "array", "items": { "type": "string" } }, "subnetId": { "type": "string" } }, "type": "object", "required": [ "associateCarrierIpAddress", "connectionTrackingSpecifications", "description", "deviceIndex", "interfaceType", "ipv4AddressCount", "ipv4Addresses", "ipv4PrefixCount", "ipv4Prefixes", "ipv6AddressCount", "ipv6Addresses", "ipv6PrefixCount", "ipv6Prefixes", "networkCardIndex", "networkInterfaceId", "primaryIpv6", "privateIpAddress", "securityGroups", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateNetworkInterfaceConnectionTrackingSpecification:getLaunchTemplateNetworkInterfaceConnectionTrackingSpecification": { "properties": { "tcpEstablishedTimeout": { "type": "integer" }, "udpStreamTimeout": { "type": "integer" }, "udpTimeout": { "type": "integer" } }, "type": "object", "required": [ "tcpEstablishedTimeout", "udpStreamTimeout", "udpTimeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplatePlacement:getLaunchTemplatePlacement": { "properties": { "affinity": { "type": "string" }, "availabilityZone": { "type": "string" }, "groupName": { "type": "string" }, "hostId": { "type": "string" }, "hostResourceGroupArn": { "type": "string" }, "partitionNumber": { "type": "integer" }, "spreadDomain": { "type": "string" }, "tenancy": { "type": "string" } }, "type": "object", "required": [ "affinity", "availabilityZone", "groupName", "hostId", "hostResourceGroupArn", "partitionNumber", "spreadDomain", "tenancy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplatePrivateDnsNameOption:getLaunchTemplatePrivateDnsNameOption": { "properties": { "enableResourceNameDnsARecord": { "type": "boolean" }, "enableResourceNameDnsAaaaRecord": { "type": "boolean" }, "hostnameType": { "type": "string" } }, "type": "object", "required": [ "enableResourceNameDnsARecord", "enableResourceNameDnsAaaaRecord", "hostnameType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLaunchTemplateTagSpecification:getLaunchTemplateTagSpecification": { "properties": { "resourceType": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags, each pair of which must exactly match a pair on the desired Launch Template.\n" } }, "type": "object", "required": [ "resourceType", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getLocalGatewayFilter:getLocalGatewayFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Local Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewayRouteTableFilter:getLocalGatewayRouteTableFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayRouteTables.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA local gateway route table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewayRouteTablesFilter:getLocalGatewayRouteTablesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayRouteTables.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Local Gateway Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewayVirtualInterfaceFilter:getLocalGatewayVirtualInterfaceFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewayVirtualInterfaceGroupFilter:getLocalGatewayVirtualInterfaceGroupFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewayVirtualInterfaceGroupsFilter:getLocalGatewayVirtualInterfaceGroupsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getLocalGatewaysFilter:getLocalGatewaysFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Local Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getManagedPrefixListEntry:getManagedPrefixListEntry": { "properties": { "cidr": { "type": "string" }, "description": { "type": "string" } }, "type": "object", "required": [ "cidr", "description" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getManagedPrefixListFilter:getManagedPrefixListFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [DescribeManagedPrefixLists](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeManagedPrefixLists.html) API Reference.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getManagedPrefixListsFilter:getManagedPrefixListsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeManagedPrefixLists.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA managed prefix list will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNatGatewayFilter:getNatGatewayFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nAn Nat Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNatGatewaysFilter:getNatGatewaysFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Nat Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNetworkAclsFilter:getNetworkAclsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNetworkInsightsAnalysisAlternatePathHint:getNetworkInsightsAnalysisAlternatePathHint": { "properties": { "componentArn": { "type": "string" }, "componentId": { "type": "string" } }, "type": "object", "required": [ "componentArn", "componentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanation:getNetworkInsightsAnalysisExplanation": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationAclRule:getNetworkInsightsAnalysisExplanationAclRule" } }, "acls": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationAcl:getNetworkInsightsAnalysisExplanationAcl" } }, "address": { "type": "string" }, "addresses": { "type": "array", "items": { "type": "string" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationAttachedTo:getNetworkInsightsAnalysisExplanationAttachedTo" } }, "availabilityZones": { "type": "array", "items": { "type": "string" } }, "cidrs": { "type": "array", "items": { "type": "string" } }, "classicLoadBalancerListeners": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationClassicLoadBalancerListener:getNetworkInsightsAnalysisExplanationClassicLoadBalancerListener" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationComponent:getNetworkInsightsAnalysisExplanationComponent" } }, "customerGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationCustomerGateway:getNetworkInsightsAnalysisExplanationCustomerGateway" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationDestinationVpc:getNetworkInsightsAnalysisExplanationDestinationVpc" } }, "destinations": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationDestination:getNetworkInsightsAnalysisExplanationDestination" } }, "direction": { "type": "string" }, "elasticLoadBalancerListeners": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationElasticLoadBalancerListener:getNetworkInsightsAnalysisExplanationElasticLoadBalancerListener" } }, "explanationCode": { "type": "string" }, "ingressRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationIngressRouteTable:getNetworkInsightsAnalysisExplanationIngressRouteTable" } }, "internetGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationInternetGateway:getNetworkInsightsAnalysisExplanationInternetGateway" } }, "loadBalancerArn": { "type": "string" }, "loadBalancerListenerPort": { "type": "integer" }, "loadBalancerTargetGroup": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup" } }, "loadBalancerTargetGroups": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup" } }, "loadBalancerTargetPort": { "type": "integer" }, "missingComponent": { "type": "string" }, "natGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationNatGateway:getNetworkInsightsAnalysisExplanationNatGateway" } }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationNetworkInterface:getNetworkInsightsAnalysisExplanationNetworkInterface" } }, "packetField": { "type": "string" }, "port": { "type": "integer" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationPortRange:getNetworkInsightsAnalysisExplanationPortRange" } }, "prefixLists": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationPrefixList:getNetworkInsightsAnalysisExplanationPrefixList" } }, "protocols": { "type": "array", "items": { "type": "string" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationRouteTableRoute:getNetworkInsightsAnalysisExplanationRouteTableRoute" } }, "routeTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationRouteTable:getNetworkInsightsAnalysisExplanationRouteTable" } }, "securityGroup": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroup:getNetworkInsightsAnalysisExplanationSecurityGroup" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroupRule:getNetworkInsightsAnalysisExplanationSecurityGroupRule" } }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroup:getNetworkInsightsAnalysisExplanationSecurityGroup" } }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSourceVpc:getNetworkInsightsAnalysisExplanationSourceVpc" } }, "state": { "type": "string" }, "subnetRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSubnetRouteTable:getNetworkInsightsAnalysisExplanationSubnetRouteTable" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSubnet:getNetworkInsightsAnalysisExplanationSubnet" } }, "transitGatewayAttachments": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayAttachment:getNetworkInsightsAnalysisExplanationTransitGatewayAttachment" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute" } }, "transitGatewayRouteTables": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayRouteTable:getNetworkInsightsAnalysisExplanationTransitGatewayRouteTable" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationTransitGateway:getNetworkInsightsAnalysisExplanationTransitGateway" } }, "vpcEndpoints": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationVpcEndpoint:getNetworkInsightsAnalysisExplanationVpcEndpoint" } }, "vpcPeeringConnections": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationVpcPeeringConnection:getNetworkInsightsAnalysisExplanationVpcPeeringConnection" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationVpc:getNetworkInsightsAnalysisExplanationVpc" } }, "vpnConnections": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationVpnConnection:getNetworkInsightsAnalysisExplanationVpnConnection" } }, "vpnGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationVpnGateway:getNetworkInsightsAnalysisExplanationVpnGateway" } } }, "type": "object", "required": [ "acls", "aclRules", "address", "addresses", "attachedTos", "availabilityZones", "cidrs", "classicLoadBalancerListeners", "components", "customerGateways", "destinations", "destinationVpcs", "direction", "elasticLoadBalancerListeners", "explanationCode", "ingressRouteTables", "internetGateways", "loadBalancerArn", "loadBalancerListenerPort", "loadBalancerTargetGroup", "loadBalancerTargetGroups", "loadBalancerTargetPort", "missingComponent", "natGateways", "networkInterfaces", "packetField", "port", "portRanges", "prefixLists", "protocols", "routeTables", "routeTableRoutes", "securityGroup", "securityGroupRules", "securityGroups", "sourceVpcs", "state", "subnets", "subnetRouteTables", "transitGateways", "transitGatewayAttachments", "transitGatewayRouteTables", "transitGatewayRouteTableRoutes", "vpcs", "vpcEndpoints", "vpcPeeringConnections", "vpnConnections", "vpnGateways" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationAcl:getNetworkInsightsAnalysisExplanationAcl": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationAclRule:getNetworkInsightsAnalysisExplanationAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationAclRulePortRange:getNetworkInsightsAnalysisExplanationAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "required": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationAclRulePortRange:getNetworkInsightsAnalysisExplanationAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationAttachedTo:getNetworkInsightsAnalysisExplanationAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationClassicLoadBalancerListener:getNetworkInsightsAnalysisExplanationClassicLoadBalancerListener": { "properties": { "instancePort": { "type": "integer" }, "loadBalancerPort": { "type": "integer" } }, "type": "object", "required": [ "instancePort", "loadBalancerPort" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationComponent:getNetworkInsightsAnalysisExplanationComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationCustomerGateway:getNetworkInsightsAnalysisExplanationCustomerGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationDestination:getNetworkInsightsAnalysisExplanationDestination": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationDestinationVpc:getNetworkInsightsAnalysisExplanationDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationElasticLoadBalancerListener:getNetworkInsightsAnalysisExplanationElasticLoadBalancerListener": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationIngressRouteTable:getNetworkInsightsAnalysisExplanationIngressRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationInternetGateway:getNetworkInsightsAnalysisExplanationInternetGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup:getNetworkInsightsAnalysisExplanationLoadBalancerTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationNatGateway:getNetworkInsightsAnalysisExplanationNatGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationNetworkInterface:getNetworkInsightsAnalysisExplanationNetworkInterface": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationPortRange:getNetworkInsightsAnalysisExplanationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationPrefixList:getNetworkInsightsAnalysisExplanationPrefixList": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationRouteTable:getNetworkInsightsAnalysisExplanationRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationRouteTableRoute:getNetworkInsightsAnalysisExplanationRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "required": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroup:getNetworkInsightsAnalysisExplanationSecurityGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroupRule:getNetworkInsightsAnalysisExplanationSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroupRulePortRange:getNetworkInsightsAnalysisExplanationSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "required": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSecurityGroupRulePortRange:getNetworkInsightsAnalysisExplanationSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSourceVpc:getNetworkInsightsAnalysisExplanationSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSubnet:getNetworkInsightsAnalysisExplanationSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationSubnetRouteTable:getNetworkInsightsAnalysisExplanationSubnetRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationTransitGateway:getNetworkInsightsAnalysisExplanationTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayAttachment:getNetworkInsightsAnalysisExplanationTransitGatewayAttachment": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayRouteTable:getNetworkInsightsAnalysisExplanationTransitGatewayRouteTable": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisExplanationTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "required": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationVpc:getNetworkInsightsAnalysisExplanationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationVpcEndpoint:getNetworkInsightsAnalysisExplanationVpcEndpoint": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationVpcPeeringConnection:getNetworkInsightsAnalysisExplanationVpcPeeringConnection": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationVpnConnection:getNetworkInsightsAnalysisExplanationVpnConnection": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisExplanationVpnGateway:getNetworkInsightsAnalysisExplanationVpnGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisFilter:getNetworkInsightsAnalysisFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponent:getNetworkInsightsAnalysisForwardPathComponent": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAclRule:getNetworkInsightsAnalysisForwardPathComponentAclRule" } }, "additionalDetails": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAdditionalDetail:getNetworkInsightsAnalysisForwardPathComponentAdditionalDetail" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAttachedTo:getNetworkInsightsAnalysisForwardPathComponentAttachedTo" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentComponent:getNetworkInsightsAnalysisForwardPathComponentComponent" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentDestinationVpc:getNetworkInsightsAnalysisForwardPathComponentDestinationVpc" } }, "inboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeader:getNetworkInsightsAnalysisForwardPathComponentInboundHeader" } }, "outboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeader:getNetworkInsightsAnalysisForwardPathComponentOutboundHeader" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentRouteTableRoute:getNetworkInsightsAnalysisForwardPathComponentRouteTableRoute" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRule:getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRule" } }, "sequenceNumber": { "type": "integer" }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSourceVpc:getNetworkInsightsAnalysisForwardPathComponentSourceVpc" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSubnet:getNetworkInsightsAnalysisForwardPathComponentSubnet" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentTransitGateway:getNetworkInsightsAnalysisForwardPathComponentTransitGateway" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentVpc:getNetworkInsightsAnalysisForwardPathComponentVpc" } } }, "type": "object", "required": [ "aclRules", "additionalDetails", "attachedTos", "components", "destinationVpcs", "inboundHeaders", "outboundHeaders", "routeTableRoutes", "securityGroupRules", "sequenceNumber", "sourceVpcs", "subnets", "transitGateways", "transitGatewayRouteTableRoutes", "vpcs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAclRule:getNetworkInsightsAnalysisForwardPathComponentAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAclRulePortRange:getNetworkInsightsAnalysisForwardPathComponentAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "required": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAclRulePortRange:getNetworkInsightsAnalysisForwardPathComponentAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAdditionalDetail:getNetworkInsightsAnalysisForwardPathComponentAdditionalDetail": { "properties": { "additionalDetailType": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent:getNetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent" } } }, "type": "object", "required": [ "additionalDetailType", "components" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent:getNetworkInsightsAnalysisForwardPathComponentAdditionalDetailComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentAttachedTo:getNetworkInsightsAnalysisForwardPathComponentAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentComponent:getNetworkInsightsAnalysisForwardPathComponentComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentDestinationVpc:getNetworkInsightsAnalysisForwardPathComponentDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeader:getNetworkInsightsAnalysisForwardPathComponentInboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange:getNetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange:getNetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange" } } }, "type": "object", "required": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange:getNetworkInsightsAnalysisForwardPathComponentInboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange:getNetworkInsightsAnalysisForwardPathComponentInboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeader:getNetworkInsightsAnalysisForwardPathComponentOutboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange:getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange:getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange" } } }, "type": "object", "required": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange:getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange:getNetworkInsightsAnalysisForwardPathComponentOutboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentRouteTableRoute:getNetworkInsightsAnalysisForwardPathComponentRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "required": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRule:getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange:getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "required": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange:getNetworkInsightsAnalysisForwardPathComponentSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSourceVpc:getNetworkInsightsAnalysisForwardPathComponentSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentSubnet:getNetworkInsightsAnalysisForwardPathComponentSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentTransitGateway:getNetworkInsightsAnalysisForwardPathComponentTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisForwardPathComponentTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "required": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisForwardPathComponentVpc:getNetworkInsightsAnalysisForwardPathComponentVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponent:getNetworkInsightsAnalysisReturnPathComponent": { "properties": { "aclRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAclRule:getNetworkInsightsAnalysisReturnPathComponentAclRule" } }, "additionalDetails": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAdditionalDetail:getNetworkInsightsAnalysisReturnPathComponentAdditionalDetail" } }, "attachedTos": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAttachedTo:getNetworkInsightsAnalysisReturnPathComponentAttachedTo" } }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentComponent:getNetworkInsightsAnalysisReturnPathComponentComponent" } }, "destinationVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentDestinationVpc:getNetworkInsightsAnalysisReturnPathComponentDestinationVpc" } }, "inboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeader:getNetworkInsightsAnalysisReturnPathComponentInboundHeader" } }, "outboundHeaders": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeader:getNetworkInsightsAnalysisReturnPathComponentOutboundHeader" } }, "routeTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentRouteTableRoute:getNetworkInsightsAnalysisReturnPathComponentRouteTableRoute" } }, "securityGroupRules": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRule:getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRule" } }, "sequenceNumber": { "type": "integer" }, "sourceVpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSourceVpc:getNetworkInsightsAnalysisReturnPathComponentSourceVpc" } }, "subnets": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSubnet:getNetworkInsightsAnalysisReturnPathComponentSubnet" } }, "transitGatewayRouteTableRoutes": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute" } }, "transitGateways": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentTransitGateway:getNetworkInsightsAnalysisReturnPathComponentTransitGateway" } }, "vpcs": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentVpc:getNetworkInsightsAnalysisReturnPathComponentVpc" } } }, "type": "object", "required": [ "aclRules", "additionalDetails", "attachedTos", "components", "destinationVpcs", "inboundHeaders", "outboundHeaders", "routeTableRoutes", "securityGroupRules", "sequenceNumber", "sourceVpcs", "subnets", "transitGateways", "transitGatewayRouteTableRoutes", "vpcs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAclRule:getNetworkInsightsAnalysisReturnPathComponentAclRule": { "properties": { "cidr": { "type": "string" }, "egress": { "type": "boolean" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAclRulePortRange:getNetworkInsightsAnalysisReturnPathComponentAclRulePortRange" } }, "protocol": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleNumber": { "type": "integer" } }, "type": "object", "required": [ "cidr", "egress", "portRanges", "protocol", "ruleAction", "ruleNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAclRulePortRange:getNetworkInsightsAnalysisReturnPathComponentAclRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAdditionalDetail:getNetworkInsightsAnalysisReturnPathComponentAdditionalDetail": { "properties": { "additionalDetailType": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent:getNetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent" } } }, "type": "object", "required": [ "additionalDetailType", "components" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent:getNetworkInsightsAnalysisReturnPathComponentAdditionalDetailComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentAttachedTo:getNetworkInsightsAnalysisReturnPathComponentAttachedTo": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentComponent:getNetworkInsightsAnalysisReturnPathComponentComponent": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentDestinationVpc:getNetworkInsightsAnalysisReturnPathComponentDestinationVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeader:getNetworkInsightsAnalysisReturnPathComponentInboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange:getNetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange:getNetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange" } } }, "type": "object", "required": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange:getNetworkInsightsAnalysisReturnPathComponentInboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange:getNetworkInsightsAnalysisReturnPathComponentInboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeader:getNetworkInsightsAnalysisReturnPathComponentOutboundHeader": { "properties": { "destinationAddresses": { "type": "array", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange:getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange" } }, "protocol": { "type": "string" }, "sourceAddresses": { "type": "array", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange:getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange" } } }, "type": "object", "required": [ "destinationAddresses", "destinationPortRanges", "protocol", "sourceAddresses", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange:getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderDestinationPortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange:getNetworkInsightsAnalysisReturnPathComponentOutboundHeaderSourcePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentRouteTableRoute:getNetworkInsightsAnalysisReturnPathComponentRouteTableRoute": { "properties": { "destinationCidr": { "type": "string" }, "destinationPrefixListId": { "type": "string" }, "egressOnlyInternetGatewayId": { "type": "string" }, "gatewayId": { "type": "string" }, "instanceId": { "type": "string" }, "natGatewayId": { "type": "string" }, "networkInterfaceId": { "type": "string" }, "origin": { "type": "string" }, "transitGatewayId": { "type": "string" }, "vpcPeeringConnectionId": { "type": "string" } }, "type": "object", "required": [ "destinationCidr", "destinationPrefixListId", "egressOnlyInternetGatewayId", "gatewayId", "instanceId", "natGatewayId", "networkInterfaceId", "origin", "transitGatewayId", "vpcPeeringConnectionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRule:getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRule": { "properties": { "cidr": { "type": "string" }, "direction": { "type": "string" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange:getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange" } }, "prefixListId": { "type": "string" }, "protocol": { "type": "string" }, "securityGroupId": { "type": "string" } }, "type": "object", "required": [ "cidr", "direction", "portRanges", "prefixListId", "protocol", "securityGroupId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange:getNetworkInsightsAnalysisReturnPathComponentSecurityGroupRulePortRange": { "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSourceVpc:getNetworkInsightsAnalysisReturnPathComponentSourceVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentSubnet:getNetworkInsightsAnalysisReturnPathComponentSubnet": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentTransitGateway:getNetworkInsightsAnalysisReturnPathComponentTransitGateway": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute:getNetworkInsightsAnalysisReturnPathComponentTransitGatewayRouteTableRoute": { "properties": { "attachmentId": { "type": "string" }, "destinationCidr": { "type": "string" }, "prefixListId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "routeOrigin": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "required": [ "attachmentId", "destinationCidr", "prefixListId", "resourceId", "resourceType", "routeOrigin", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsAnalysisReturnPathComponentVpc:getNetworkInsightsAnalysisReturnPathComponentVpc": { "properties": { "arn": { "type": "string", "description": "ARN of the selected Network Insights Analysis.\n" }, "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsAnalyses`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsAnalyses.html) API Reference.\n" } }, "type": "object", "required": [ "arn", "id", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInsightsPathFilter:getNetworkInsightsPathFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the EC2 [`DescribeNetworkInsightsPaths`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInsightsPaths.html) API Reference.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNetworkInterfaceAssociation:getNetworkInterfaceAssociation": { "properties": { "allocationId": { "type": "string", "description": "Allocation ID.\n" }, "associationId": { "type": "string", "description": "Association ID.\n" }, "carrierIp": { "type": "string", "description": "Carrier IP address associated with the network interface. This attribute is only set when the network interface is in a subnet which is associated with a Wavelength Zone.\n" }, "customerOwnedIp": { "type": "string", "description": "Customer-owned IP address.\n" }, "ipOwnerId": { "type": "string", "description": "ID of the Elastic IP address owner.\n" }, "publicDnsName": { "type": "string", "description": "Public DNS name.\n" }, "publicIp": { "type": "string", "description": "Address of the Elastic IP address bound to the network interface.\n" } }, "type": "object", "required": [ "allocationId", "associationId", "carrierIp", "customerOwnedIp", "ipOwnerId", "publicDnsName", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInterfaceAttachment:getNetworkInterfaceAttachment": { "properties": { "attachmentId": { "type": "string" }, "deviceIndex": { "type": "integer" }, "instanceId": { "type": "string" }, "instanceOwnerId": { "type": "string" } }, "type": "object", "required": [ "attachmentId", "deviceIndex", "instanceId", "instanceOwnerId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getNetworkInterfaceFilter:getNetworkInterfaceFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getNetworkInterfacesFilter:getNetworkInterfacesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getPrefixListFilter:getPrefixListFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribePrefixLists API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePrefixLists.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getPublicIpv4PoolPoolAddressRange:getPublicIpv4PoolPoolAddressRange": { "properties": { "addressCount": { "type": "integer", "description": "Number of addresses in the range.\n" }, "availableAddressCount": { "type": "integer", "description": "Number of available addresses in the range.\n" }, "firstAddress": { "type": "string", "description": "First address in the range.\n" }, "lastAddress": { "type": "string", "description": "Last address in the range.\n" } }, "type": "object", "required": [ "addressCount", "availableAddressCount", "firstAddress", "lastAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getPublicIpv4PoolsFilter:getPublicIpv4PoolsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. Pool IDs will be selected if any one of the given values match.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getRouteTableAssociation:getRouteTableAssociation": { "properties": { "gatewayId": { "type": "string", "description": "ID of an Internet Gateway or Virtual Private Gateway which is connected to the Route Table (not exported if not passed as a parameter).\n" }, "main": { "type": "boolean", "description": "Whether the association is due to the main route table.\n" }, "routeTableAssociationId": { "type": "string", "description": "Association ID.\n" }, "routeTableId": { "type": "string", "description": "ID of the specific Route Table to retrieve.\n" }, "subnetId": { "type": "string", "description": "ID of a Subnet which is connected to the Route Table (not exported if not passed as a parameter).\n" } }, "type": "object", "required": [ "gatewayId", "main", "routeTableAssociationId", "routeTableId", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getRouteTableFilter:getRouteTableFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. A Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getRouteTableRoute:getRouteTableRoute": { "properties": { "carrierGatewayId": { "type": "string", "description": "ID of the Carrier Gateway.\n" }, "cidrBlock": { "type": "string", "description": "CIDR block of the route.\n" }, "coreNetworkArn": { "type": "string", "description": "ARN of the core network.\n" }, "destinationPrefixListId": { "type": "string", "description": "The ID of a managed prefix list destination of the route.\n" }, "egressOnlyGatewayId": { "type": "string", "description": "ID of the Egress Only Internet Gateway.\n" }, "gatewayId": { "type": "string", "description": "ID of an Internet Gateway or Virtual Private Gateway which is connected to the Route Table (not exported if not passed as a parameter).\n" }, "instanceId": { "type": "string", "description": "EC2 instance ID.\n" }, "ipv6CidrBlock": { "type": "string", "description": "IPv6 CIDR block of the route.\n" }, "localGatewayId": { "type": "string", "description": "Local Gateway ID.\n" }, "natGatewayId": { "type": "string", "description": "NAT Gateway ID.\n" }, "networkInterfaceId": { "type": "string", "description": "ID of the elastic network interface (eni) to use.\n" }, "transitGatewayId": { "type": "string", "description": "EC2 Transit Gateway ID.\n" }, "vpcEndpointId": { "type": "string", "description": "VPC Endpoint ID.\n" }, "vpcPeeringConnectionId": { "type": "string", "description": "VPC Peering ID.\n" } }, "type": "object", "required": [ "carrierGatewayId", "cidrBlock", "coreNetworkArn", "destinationPrefixListId", "egressOnlyGatewayId", "gatewayId", "instanceId", "ipv6CidrBlock", "localGatewayId", "natGatewayId", "networkInterfaceId", "transitGatewayId", "vpcEndpointId", "vpcPeeringConnectionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getRouteTablesFilter:getRouteTablesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getSecurityGroupFilter:getSecurityGroupFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Security Group will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getSecurityGroupsFilter:getSecurityGroupsFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getSpotPriceFilter:getSpotPriceFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getSubnetFilter:getSubnetFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. A subnet will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getSubnetsFilter:getSubnetsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html).\nFor example, if matching against tag `Name`, use:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst selected = aws.ec2.getSubnets({\n filters: [{\n name: \"tag:Name\",\n values: [\"\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\nselected = aws.ec2.get_subnets(filters=[{\n \"name\": \"tag:Name\",\n \"values\": [\"\"],\n}])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var selected = Aws.Ec2.GetSubnets.Invoke(new()\n {\n Filters = new[]\n {\n new Aws.Ec2.Inputs.GetSubnetsFilterInputArgs\n {\n Name = \"tag:Name\",\n Values = new[]\n {\n \"\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ec2.GetSubnets(ctx, \u0026ec2.GetSubnetsArgs{\n\t\t\tFilters: []ec2.GetSubnetsFilter{\n\t\t\t\t{\n\t\t\t\t\tName: \"tag:Name\",\n\t\t\t\t\tValues: []string{\n\t\t\t\t\t\t\"\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.ec2.Ec2Functions;\nimport com.pulumi.aws.ec2.inputs.GetSubnetsArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var selected = Ec2Functions.getSubnets(GetSubnetsArgs.builder()\n .filters(GetSubnetsFilterArgs.builder()\n .name(\"tag:Name\")\n .values(\"\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nvariables:\n selected:\n fn::invoke:\n function: aws:ec2:getSubnets\n arguments:\n filters:\n - name: tag:Name\n values:\n - \"\"\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nSubnet IDs will be selected if any one of the given values match.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getTransitGatewayRouteTablesFilter:getTransitGatewayRouteTablesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayRouteTables.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Transit Gateway Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcCidrBlockAssociation:getVpcCidrBlockAssociation": { "properties": { "associationId": { "type": "string", "description": "Association ID for the IPv4 CIDR block.\n" }, "cidrBlock": { "type": "string", "description": "Cidr block of the desired VPC.\n" }, "state": { "type": "string", "description": "Current state of the desired VPC.\nCan be either `\"pending\"` or `\"available\"`.\n" } }, "type": "object", "required": [ "associationId", "cidrBlock", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcDhcpOptionsFilter:getVpcDhcpOptionsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values for filtering.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcEndpointDnsEntry:getVpcEndpointDnsEntry": { "properties": { "dnsName": { "type": "string", "description": "DNS name.\n" }, "hostedZoneId": { "type": "string", "description": "ID of the private hosted zone.\n" } }, "type": "object", "required": [ "dnsName", "hostedZoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcEndpointDnsOption:getVpcEndpointDnsOption": { "properties": { "dnsRecordIpType": { "type": "string", "description": "The DNS records created for the endpoint.\n" }, "privateDnsOnlyForInboundResolverEndpoint": { "type": "boolean", "description": "Indicates whether to enable private DNS only for inbound endpoints.\n" } }, "type": "object", "required": [ "dnsRecordIpType", "privateDnsOnlyForInboundResolverEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcEndpointFilter:getVpcEndpointFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC Endpoint will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcEndpointServiceFilter:getVpcEndpointServiceFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeVpcEndpointServices API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpointServices.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcFilter:getVpcFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIamPoolCidrsFilter:getVpcIamPoolCidrsFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIamPoolCidrsIpamPoolCidr:getVpcIamPoolCidrsIpamPoolCidr": { "properties": { "cidr": { "type": "string", "description": "A network CIDR.\n" }, "state": { "type": "string", "description": "The provisioning state of that CIDR.\n" } }, "type": "object", "required": [ "cidr", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIamPoolFilter:getVpcIamPoolFilter": { "properties": { "name": { "type": "string", "description": "The name of the filter. Filter names are case-sensitive.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The filter values. Filter values are case-sensitive.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIamPoolsFilter:getVpcIamPoolsFilter": { "properties": { "name": { "type": "string", "description": "The name of the filter. Filter names are case-sensitive.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The filter values. Filter values are case-sensitive.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIamPoolsIpamPool:getVpcIamPoolsIpamPool": { "properties": { "addressFamily": { "type": "string", "description": "IP protocol assigned to this pool.\n" }, "allocationDefaultNetmaskLength": { "type": "integer", "description": "A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is `10.0.0.0/8` and you enter 16 here, new allocations will default to `10.0.0.0/16`.\n" }, "allocationMaxNetmaskLength": { "type": "integer", "description": "The maximum netmask length that will be required for CIDR allocations in this pool.\n" }, "allocationMinNetmaskLength": { "type": "integer", "description": "The minimum netmask length that will be required for CIDR allocations in this pool.\n" }, "allocationResourceTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Tags that are required to create resources in using this pool.\n" }, "arn": { "type": "string", "description": "ARN of the pool\n" }, "autoImport": { "type": "boolean", "description": "If enabled, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.\n" }, "awsService": { "type": "string", "description": "Limits which service in AWS that the pool can be used in. `ec2` for example, allows users to use space for Elastic IP addresses and VPCs.\n" }, "description": { "type": "string", "description": "Description for the IPAM pool.\n" }, "id": { "type": "string", "description": "ID of the IPAM pool.\n" }, "ipamScopeId": { "type": "string", "description": "ID of the scope the pool belongs to.\n" }, "ipamScopeType": { "type": "string" }, "locale": { "type": "string", "description": "Locale is the Region where your pool is available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region.\n" }, "poolDepth": { "type": "integer" }, "publiclyAdvertisable": { "type": "boolean", "description": "Defines whether or not IPv6 pool space is publicly advertisable over the internet.\n" }, "sourceIpamPoolId": { "type": "string", "description": "ID of the source IPAM pool.\n" }, "state": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assigned to the resource.\n" } }, "type": "object", "required": [ "addressFamily", "allocationDefaultNetmaskLength", "allocationMaxNetmaskLength", "allocationMinNetmaskLength", "allocationResourceTags", "arn", "autoImport", "awsService", "description", "id", "ipamScopeId", "ipamScopeType", "locale", "poolDepth", "publiclyAdvertisable", "sourceIpamPoolId", "state", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIpamOperatingRegion:getVpcIpamOperatingRegion": { "properties": { "regionName": { "type": "string" } }, "type": "object", "required": [ "regionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIpamPoolCidrsFilter:getVpcIpamPoolCidrsFilter": { "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIpamPoolCidrsIpamPoolCidr:getVpcIpamPoolCidrsIpamPoolCidr": { "properties": { "cidr": { "type": "string", "description": "A network CIDR.\n" }, "state": { "type": "string", "description": "The provisioning state of that CIDR.\n" } }, "type": "object", "required": [ "cidr", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIpamPoolFilter:getVpcIpamPoolFilter": { "properties": { "name": { "type": "string", "description": "The name of the filter. Filter names are case-sensitive.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The filter values. Filter values are case-sensitive.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIpamPoolsFilter:getVpcIpamPoolsFilter": { "properties": { "name": { "type": "string", "description": "The name of the filter. Filter names are case-sensitive.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The filter values. Filter values are case-sensitive.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIpamPoolsIpamPool:getVpcIpamPoolsIpamPool": { "properties": { "addressFamily": { "type": "string", "description": "IP protocol assigned to this pool.\n" }, "allocationDefaultNetmaskLength": { "type": "integer", "description": "A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is `10.0.0.0/8` and you enter 16 here, new allocations will default to `10.0.0.0/16`.\n" }, "allocationMaxNetmaskLength": { "type": "integer", "description": "The maximum netmask length that will be required for CIDR allocations in this pool.\n" }, "allocationMinNetmaskLength": { "type": "integer", "description": "The minimum netmask length that will be required for CIDR allocations in this pool.\n" }, "allocationResourceTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Tags that are required to create resources in using this pool.\n" }, "arn": { "type": "string", "description": "ARN of the pool\n" }, "autoImport": { "type": "boolean", "description": "If enabled, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.\n" }, "awsService": { "type": "string", "description": "Limits which service in AWS that the pool can be used in. `ec2` for example, allows users to use space for Elastic IP addresses and VPCs.\n" }, "description": { "type": "string", "description": "Description for the IPAM pool.\n" }, "id": { "type": "string", "description": "ID of the IPAM pool.\n" }, "ipamScopeId": { "type": "string", "description": "ID of the scope the pool belongs to.\n" }, "ipamScopeType": { "type": "string" }, "locale": { "type": "string", "description": "Locale is the Region where your pool is available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region.\n" }, "poolDepth": { "type": "integer" }, "publiclyAdvertisable": { "type": "boolean", "description": "Defines whether or not IPv6 pool space is publicly advertisable over the internet.\n" }, "sourceIpamPoolId": { "type": "string", "description": "ID of the source IPAM pool.\n" }, "state": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of tags to assigned to the resource.\n" } }, "type": "object", "required": [ "addressFamily", "allocationDefaultNetmaskLength", "allocationMaxNetmaskLength", "allocationMinNetmaskLength", "allocationResourceTags", "arn", "autoImport", "awsService", "description", "id", "ipamScopeId", "ipamScopeType", "locale", "poolDepth", "publiclyAdvertisable", "sourceIpamPoolId", "state", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIpamsFilter:getVpcIpamsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeIpams.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nAn IPAM resource will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcIpamsIpam:getVpcIpamsIpam": { "properties": { "arn": { "type": "string", "description": "ARN of the IPAM.\n" }, "defaultResourceDiscoveryAssociationId": { "type": "string", "description": "The default resource discovery association ID.\n" }, "defaultResourceDiscoveryId": { "type": "string", "description": "The default resource discovery ID.\n" }, "description": { "type": "string", "description": "Description for the IPAM.\n" }, "enablePrivateGua": { "type": "boolean", "description": "If private GUA is enabled.\n" }, "id": { "type": "string", "description": "ID of the IPAM resource.\n" }, "ipamRegion": { "type": "string", "description": "Region that the IPAM exists in.\n" }, "operatingRegions": { "type": "array", "items": { "$ref": "#/types/aws:ec2/getVpcIpamsIpamOperatingRegion:getVpcIpamsIpamOperatingRegion" }, "description": "Regions that the IPAM is configured to operate in.\n" }, "ownerId": { "type": "string", "description": "ID of the account that owns this IPAM.\n" }, "privateDefaultScopeId": { "type": "string", "description": "ID of the default private scope.\n" }, "publicDefaultScopeId": { "type": "string", "description": "ID of the default public scope.\n" }, "resourceDiscoveryAssociationCount": { "type": "integer", "description": "Number of resource discovery associations.\n" }, "scopeCount": { "type": "integer", "description": "Number of scopes on this IPAM.\n" }, "state": { "type": "string", "description": "Current state of the IPAM.\n" }, "stateMessage": { "type": "string", "description": "State message of the IPAM.\n" }, "tier": { "type": "string", "description": "IPAM Tier.\n" } }, "type": "object", "required": [ "arn", "defaultResourceDiscoveryAssociationId", "defaultResourceDiscoveryId", "description", "enablePrivateGua", "id", "ipamRegion", "operatingRegions", "ownerId", "privateDefaultScopeId", "publicDefaultScopeId", "resourceDiscoveryAssociationCount", "scopeCount", "state", "stateMessage", "tier" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcIpamsIpamOperatingRegion:getVpcIpamsIpamOperatingRegion": { "properties": { "regionName": { "type": "string" } }, "type": "object", "required": [ "regionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcPeeringConnectionCidrBlockSet:getVpcPeeringConnectionCidrBlockSet": { "properties": { "cidrBlock": { "type": "string", "description": "Primary CIDR block of the requester VPC of the specific VPC Peering Connection to retrieve.\n" } }, "type": "object", "required": [ "cidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcPeeringConnectionFilter:getVpcPeeringConnectionFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC Peering Connection will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcPeeringConnectionIpv6CidrBlockSet:getVpcPeeringConnectionIpv6CidrBlockSet": { "properties": { "ipv6CidrBlock": { "type": "string" } }, "type": "object", "required": [ "ipv6CidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcPeeringConnectionPeerCidrBlockSet:getVpcPeeringConnectionPeerCidrBlockSet": { "properties": { "cidrBlock": { "type": "string", "description": "Primary CIDR block of the requester VPC of the specific VPC Peering Connection to retrieve.\n" } }, "type": "object", "required": [ "cidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcPeeringConnectionPeerIpv6CidrBlockSet:getVpcPeeringConnectionPeerIpv6CidrBlockSet": { "properties": { "ipv6CidrBlock": { "type": "string" } }, "type": "object", "required": [ "ipv6CidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2/getVpcPeeringConnectionsFilter:getVpcPeeringConnectionsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC Peering Connection will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpcsFilter:getVpcsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPC will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2/getVpnGatewayFilter:getVpnGatewayFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA VPN Gateway will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2clientvpn/EndpointAuthenticationOption:EndpointAuthenticationOption": { "properties": { "activeDirectoryId": { "type": "string", "description": "The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.\n", "willReplaceOnChanges": true }, "rootCertificateChainArn": { "type": "string", "description": "The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). Only necessary when type is set to `certificate-authentication`.\n", "willReplaceOnChanges": true }, "samlProviderArn": { "type": "string", "description": "The ARN of the IAM SAML identity provider if type is `federated-authentication`.\n", "willReplaceOnChanges": true }, "selfServiceSamlProviderArn": { "type": "string", "description": "The ARN of the IAM SAML identity provider for the self service portal if type is `federated-authentication`.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, `directory-service-authentication` to use Active Directory authentication, or `federated-authentication` to use Federated Authentication via SAML 2.0.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "aws:ec2clientvpn/EndpointClientConnectOptions:EndpointClientConnectOptions": { "properties": { "enabled": { "type": "boolean", "description": "Indicates whether client connect options are enabled. The default is `false` (not enabled).\n" }, "lambdaFunctionArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "lambdaFunctionArn" ] } } }, "aws:ec2clientvpn/EndpointClientLoginBannerOptions:EndpointClientLoginBannerOptions": { "properties": { "bannerText": { "type": "string", "description": "Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.\n" }, "enabled": { "type": "boolean", "description": "Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. The default is `false` (not enabled).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bannerText", "enabled" ] } } }, "aws:ec2clientvpn/EndpointConnectionLogOptions:EndpointConnectionLogOptions": { "properties": { "cloudwatchLogGroup": { "type": "string", "description": "The name of the CloudWatch Logs log group.\n" }, "cloudwatchLogStream": { "type": "string", "description": "The name of the CloudWatch Logs log stream to which the connection data is published.\n" }, "enabled": { "type": "boolean", "description": "Indicates whether connection logging is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLogStream", "enabled" ] } } }, "aws:ec2clientvpn/getEndpointAuthenticationOption:getEndpointAuthenticationOption": { "properties": { "activeDirectoryId": { "type": "string" }, "rootCertificateChainArn": { "type": "string" }, "samlProviderArn": { "type": "string" }, "selfServiceSamlProviderArn": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "required": [ "activeDirectoryId", "rootCertificateChainArn", "samlProviderArn", "selfServiceSamlProviderArn", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2clientvpn/getEndpointClientConnectOption:getEndpointClientConnectOption": { "properties": { "enabled": { "type": "boolean" }, "lambdaFunctionArn": { "type": "string" } }, "type": "object", "required": [ "enabled", "lambdaFunctionArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2clientvpn/getEndpointClientLoginBannerOption:getEndpointClientLoginBannerOption": { "properties": { "bannerText": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object", "required": [ "bannerText", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2clientvpn/getEndpointConnectionLogOption:getEndpointConnectionLogOption": { "properties": { "cloudwatchLogGroup": { "type": "string" }, "cloudwatchLogStream": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object", "required": [ "cloudwatchLogGroup", "cloudwatchLogStream", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2clientvpn/getEndpointFilter:getEndpointFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeClientVpnEndpoints.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/DefaultRouteTableAssociationTimeouts:DefaultRouteTableAssociationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2transitgateway/DefaultRouteTablePropagationTimeouts:DefaultRouteTablePropagationTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:ec2transitgateway/InstanceConnectEndpointTimeouts:InstanceConnectEndpointTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:ec2transitgateway/PeeringAttachmentOptions:PeeringAttachmentOptions": { "properties": { "dynamicRouting": { "type": "string", "description": "Indicates whether dynamic routing is enabled or disabled.. Supports `enable` and `disable`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ec2transitgateway/getAttachmentFilter:getAttachmentFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by the [underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getAttachmentsFilter:getAttachmentsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter check available value on [official documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html)\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getConnectFilter:getConnectFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getConnectPeerFilter:getConnectPeerFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getDirectConnectGatewayAttachmentFilter:getDirectConnectGatewayAttachmentFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeTransitGatewayAttachments API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getMulticastDomainAssociation:getMulticastDomainAssociation": { "properties": { "subnetId": { "type": "string", "description": "The ID of the subnet associated with the transit gateway multicast domain.\n" }, "transitGatewayAttachmentId": { "type": "string", "description": "The ID of the transit gateway attachment.\n" } }, "type": "object", "required": [ "subnetId", "transitGatewayAttachmentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2transitgateway/getMulticastDomainFilter:getMulticastDomainFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayMulticastDomains.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getMulticastDomainMember:getMulticastDomainMember": { "properties": { "groupIpAddress": { "type": "string", "description": "The IP address assigned to the transit gateway multicast group.\n" }, "networkInterfaceId": { "type": "string", "description": "The group members' network interface ID.\n" } }, "type": "object", "required": [ "groupIpAddress", "networkInterfaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2transitgateway/getMulticastDomainSource:getMulticastDomainSource": { "properties": { "groupIpAddress": { "type": "string", "description": "The IP address assigned to the transit gateway multicast group.\n" }, "networkInterfaceId": { "type": "string", "description": "The group members' network interface ID.\n" } }, "type": "object", "required": [ "groupIpAddress", "networkInterfaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2transitgateway/getPeeringAttachmentFilter:getPeeringAttachmentFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayPeeringAttachments.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nAn EC2 Transit Gateway Peering Attachment be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getPeeringAttachmentsFilter:getPeeringAttachmentsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayPeeringAttachments.html)\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getRouteTableAssociationsFilter:getRouteTableAssociationsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetTransitGatewayRouteTableAssociations.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Transit Gateway Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getRouteTableFilter:getRouteTableFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getRouteTablePropagationsFilter:getRouteTablePropagationsFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetTransitGatewayRouteTablePropagations.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\nA Transit Gateway Route Table will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getRouteTableRoutesFilter:getRouteTableRoutesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by\n[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayRoutes.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getRouteTableRoutesRoute:getRouteTableRoutesRoute": { "properties": { "destinationCidrBlock": { "type": "string", "description": "The CIDR used for route destination matches.\n" }, "prefixListId": { "type": "string", "description": "The ID of the prefix list used for destination matches.\n" }, "state": { "type": "string", "description": "The current state of the route, can be `active`, `deleted`, `pending`, `blackhole`, `deleting`.\n" }, "transitGatewayRouteTableAnnouncementId": { "type": "string", "description": "The id of the transit gateway route table announcement, most of the time it is an empty string.\n" }, "type": { "type": "string", "description": "The type of the route, can be `propagated` or `static`.\n" } }, "type": "object", "required": [ "destinationCidrBlock", "prefixListId", "state", "transitGatewayRouteTableAnnouncementId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ec2transitgateway/getTransitGatewayFilter:getTransitGatewayFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by the [underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getVpcAttachmentFilter:getVpcAttachmentFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getVpcAttachmentsFilter:getVpcAttachmentsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter check available value on [official documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayVpcAttachments.html)\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of one or more values for the filter.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ec2transitgateway/getVpnAttachmentFilter:getVpnAttachmentFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeTransitGatewayAttachments API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:ecr/RegistryScanningConfigurationRule:RegistryScanningConfigurationRule": { "properties": { "repositoryFilters": { "type": "array", "items": { "$ref": "#/types/aws:ecr/RegistryScanningConfigurationRuleRepositoryFilter:RegistryScanningConfigurationRuleRepositoryFilter" }, "description": "One or more repository filter blocks, containing a `filter` (required string filtering repositories, see pattern regex [here](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ScanningRepositoryFilter.html)) and a `filter_type` (required string, currently only `WILDCARD` is supported).\n" }, "scanFrequency": { "type": "string", "description": "The frequency that scans are performed at for a private registry. Can be `SCAN_ON_PUSH`, `CONTINUOUS_SCAN`, or `MANUAL`.\n" } }, "type": "object", "required": [ "repositoryFilters", "scanFrequency" ] }, "aws:ecr/RegistryScanningConfigurationRuleRepositoryFilter:RegistryScanningConfigurationRuleRepositoryFilter": { "properties": { "filter": { "type": "string" }, "filterType": { "type": "string" } }, "type": "object", "required": [ "filter", "filterType" ] }, "aws:ecr/ReplicationConfigurationReplicationConfiguration:ReplicationConfigurationReplicationConfiguration": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/aws:ecr/ReplicationConfigurationReplicationConfigurationRule:ReplicationConfigurationReplicationConfigurationRule" }, "description": "The replication rules for a replication configuration. A maximum of 10 are allowed per `replication_configuration`. See Rule\n" } }, "type": "object", "required": [ "rules" ] }, "aws:ecr/ReplicationConfigurationReplicationConfigurationRule:ReplicationConfigurationReplicationConfigurationRule": { "properties": { "destinations": { "type": "array", "items": { "$ref": "#/types/aws:ecr/ReplicationConfigurationReplicationConfigurationRuleDestination:ReplicationConfigurationReplicationConfigurationRuleDestination" }, "description": "the details of a replication destination. A maximum of 25 are allowed per `rule`. See Destination.\n" }, "repositoryFilters": { "type": "array", "items": { "$ref": "#/types/aws:ecr/ReplicationConfigurationReplicationConfigurationRuleRepositoryFilter:ReplicationConfigurationReplicationConfigurationRuleRepositoryFilter" }, "description": "filters for a replication rule. See Repository Filter.\n" } }, "type": "object", "required": [ "destinations" ] }, "aws:ecr/ReplicationConfigurationReplicationConfigurationRuleDestination:ReplicationConfigurationReplicationConfigurationRuleDestination": { "properties": { "region": { "type": "string", "description": "A Region to replicate to.\n" }, "registryId": { "type": "string", "description": "The account ID of the destination registry to replicate to.\n" } }, "type": "object", "required": [ "region", "registryId" ] }, "aws:ecr/ReplicationConfigurationReplicationConfigurationRuleRepositoryFilter:ReplicationConfigurationReplicationConfigurationRuleRepositoryFilter": { "properties": { "filter": { "type": "string", "description": "The repository filter details.\n" }, "filterType": { "type": "string", "description": "The repository filter type. The only supported value is `PREFIX_MATCH`, which is a repository name prefix specified with the filter parameter.\n" } }, "type": "object", "required": [ "filter", "filterType" ] }, "aws:ecr/RepositoryCreationTemplateEncryptionConfiguration:RepositoryCreationTemplateEncryptionConfiguration": { "properties": { "encryptionType": { "type": "string", "description": "The encryption type to use for any created repositories. Valid values are `AES256` or `KMS`. Defaults to `AES256`.\n" }, "kmsKey": { "type": "string", "description": "The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kmsKey" ] } } }, "aws:ecr/RepositoryEncryptionConfiguration:RepositoryEncryptionConfiguration": { "properties": { "encryptionType": { "type": "string", "description": "The encryption type to use for the repository. Valid values are `AES256` or `KMS`. Defaults to `AES256`.\n", "willReplaceOnChanges": true }, "kmsKey": { "type": "string", "description": "The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kmsKey" ] } } }, "aws:ecr/RepositoryImageScanningConfiguration:RepositoryImageScanningConfiguration": { "properties": { "scanOnPush": { "type": "boolean", "description": "Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false).\n" } }, "type": "object", "required": [ "scanOnPush" ] }, "aws:ecr/getLifecyclePolicyDocumentRule:getLifecyclePolicyDocumentRule": { "properties": { "action": { "$ref": "#/types/aws:ecr/getLifecyclePolicyDocumentRuleAction:getLifecyclePolicyDocumentRuleAction", "description": "Specifies the action type.\n" }, "description": { "type": "string", "description": "Describes the purpose of a rule within a lifecycle policy.\n" }, "priority": { "type": "integer", "description": "Sets the order in which rules are evaluated, lowest to highest. When you add rules to a lifecycle policy, you must give them each a unique value for `priority`. Values do not need to be sequential across rules in a policy. A rule with a `tag_status` value of \"any\" must have the highest value for `priority` and be evaluated last.\n" }, "selection": { "$ref": "#/types/aws:ecr/getLifecyclePolicyDocumentRuleSelection:getLifecyclePolicyDocumentRuleSelection", "description": "Collects parameters describing the selection criteria for the ECR lifecycle policy:\n" } }, "type": "object", "required": [ "priority" ] }, "aws:ecr/getLifecyclePolicyDocumentRuleAction:getLifecyclePolicyDocumentRuleAction": { "properties": { "type": { "type": "string", "description": "The supported value is `expire`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:ecr/getLifecyclePolicyDocumentRuleSelection:getLifecyclePolicyDocumentRuleSelection": { "properties": { "countNumber": { "type": "integer", "description": "Specify a count number. If the `count_type` used is \"imageCountMoreThan\", then the value is the maximum number of images that you want to retain in your repository. If the `count_type` used is \"sinceImagePushed\", then the value is the maximum age limit for your images.\n" }, "countType": { "type": "string", "description": "Specify a count type to apply to the images. If `count_type` is set to \"imageCountMoreThan\", you also specify `count_number` to create a rule that sets a limit on the number of images that exist in your repository. If `count_type` is set to \"sinceImagePushed\", you also specify `count_unit` and `count_number` to specify a time limit on the images that exist in your repository.\n" }, "countUnit": { "type": "string", "description": "Specify a count unit of days to indicate that as the unit of time, in addition to `count_number`, which is the number of days.\n" }, "tagPatternLists": { "type": "array", "items": { "type": "string" }, "description": "You must specify a comma-separated list of image tag patterns that may contain wildcards (\\*) on which to take action with your lifecycle policy. For example, if your images are tagged as `prod`, `prod1`, `prod2`, and so on, you would use the tag pattern list `[\"prod\\*\"]` to specify all of them. If you specify multiple tags, only the images with all specified tags are selected. There is a maximum limit of four wildcards (\\*) per string. For example, `[\"*test*1*2*3\", \"test*1*2*3*\"]` is valid but `[\"test*1*2*3*4*5*6\"]` is invalid.\n" }, "tagPrefixLists": { "type": "array", "items": { "type": "string" }, "description": "You must specify a comma-separated list of image tag prefixes on which to take action with your lifecycle policy. For example, if your images are tagged as `prod`, `prod1`, `prod2`, and so on, you would use the tag prefix \"prod\" to specify all of them. If you specify multiple tags, only images with all specified tags are selected.\n" }, "tagStatus": { "type": "string", "description": "Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are \"tagged\", \"untagged\", or \"any\". If you specify \"any\", then all images have the rule applied to them. If you specify \"tagged\", then you must also specify a `tag_prefix_list` value. If you specify \"untagged\", then you must omit `tag_prefix_list`.\n" } }, "type": "object", "required": [ "countNumber", "countType", "tagStatus" ] }, "aws:ecr/getRepositoryCreationTemplateEncryptionConfiguration:getRepositoryCreationTemplateEncryptionConfiguration": { "properties": { "encryptionType": { "type": "string", "description": "Encryption type to use for any created repositories, either `AES256` or `KMS`.\n" }, "kmsKey": { "type": "string", "description": "If `encryption_type` is `KMS`, the ARN of the KMS key used.\n" } }, "type": "object", "required": [ "encryptionType", "kmsKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecr/getRepositoryEncryptionConfiguration:getRepositoryEncryptionConfiguration": { "properties": { "encryptionType": { "type": "string", "description": "Encryption type to use for the repository, either `AES256` or `KMS`.\n" }, "kmsKey": { "type": "string", "description": "If `encryption_type` is `KMS`, the ARN of the KMS key used.\n" } }, "type": "object", "required": [ "encryptionType", "kmsKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecr/getRepositoryImageScanningConfiguration:getRepositoryImageScanningConfiguration": { "properties": { "scanOnPush": { "type": "boolean", "description": "Whether images are scanned after being pushed to the repository.\n" } }, "type": "object", "required": [ "scanOnPush" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecrpublic/RepositoryCatalogData:RepositoryCatalogData": { "properties": { "aboutText": { "type": "string", "description": "A detailed description of the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.\n" }, "architectures": { "type": "array", "items": { "type": "string" }, "description": "The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures will appear as badges on the repository and are used as search filters: `ARM`, `ARM 64`, `x86`, `x86-64`\n" }, "description": { "type": "string", "description": "A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.\n" }, "logoImageBlob": { "type": "string", "description": "The base64-encoded repository logo payload. (Only visible for verified accounts) Note that drift detection is disabled for this attribute.\n" }, "operatingSystems": { "type": "array", "items": { "type": "string" }, "description": "The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems will appear as badges on the repository and are used as search filters: `Linux`, `Windows`\n" }, "usageText": { "type": "string", "description": "Detailed information on how to use the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "logoImageBlob" ] } } }, "aws:ecs/CapacityProviderAutoScalingGroupProvider:CapacityProviderAutoScalingGroupProvider": { "properties": { "autoScalingGroupArn": { "type": "string", "description": "ARN of the associated auto scaling group.\n", "willReplaceOnChanges": true }, "managedDraining": { "type": "string", "description": "Enables or disables a graceful shutdown of instances without disturbing workloads. Valid values are `ENABLED` and `DISABLED`. The default value is `ENABLED` when a capacity provider is created.\n" }, "managedScaling": { "$ref": "#/types/aws:ecs/CapacityProviderAutoScalingGroupProviderManagedScaling:CapacityProviderAutoScalingGroupProviderManagedScaling", "description": "Configuration block defining the parameters of the auto scaling. Detailed below.\n" }, "managedTerminationProtection": { "type": "string", "description": "Enables or disables container-aware termination of instances in the auto scaling group when scale-in happens. Valid values are `ENABLED` and `DISABLED`.\n" } }, "type": "object", "required": [ "autoScalingGroupArn" ], "language": { "nodejs": { "requiredOutputs": [ "autoScalingGroupArn", "managedDraining", "managedScaling", "managedTerminationProtection" ] } } }, "aws:ecs/CapacityProviderAutoScalingGroupProviderManagedScaling:CapacityProviderAutoScalingGroupProviderManagedScaling": { "properties": { "instanceWarmupPeriod": { "type": "integer", "description": "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.\n\nFor more information on how the instance warmup period contributes to managed scale-out behavior, see [Control the instances Amazon ECS terminates](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/managed-termination-protection.html) in the _Amazon Elastic Container Service Developer Guide_.\n" }, "maximumScalingStepSize": { "type": "integer", "description": "Maximum step adjustment size. A number between 1 and 10,000.\n" }, "minimumScalingStepSize": { "type": "integer", "description": "Minimum step adjustment size. A number between 1 and 10,000.\n" }, "status": { "type": "string", "description": "Whether auto scaling is managed by ECS. Valid values are `ENABLED` and `DISABLED`.\n" }, "targetCapacity": { "type": "integer", "description": "Target utilization for the capacity provider. A number between 1 and 100.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceWarmupPeriod", "maximumScalingStepSize", "minimumScalingStepSize", "status", "targetCapacity" ] } } }, "aws:ecs/ClusterCapacityProvidersDefaultCapacityProviderStrategy:ClusterCapacityProvidersDefaultCapacityProviderStrategy": { "properties": { "base": { "type": "integer", "description": "The number of 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. Defaults to `0`.\n" }, "capacityProvider": { "type": "string", "description": "Name of the capacity provider.\n" }, "weight": { "type": "integer", "description": "The relative percentage of the total number of launched tasks that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` count of tasks has been satisfied. Defaults to `0`.\n" } }, "type": "object", "required": [ "capacityProvider" ] }, "aws:ecs/ClusterConfiguration:ClusterConfiguration": { "properties": { "executeCommandConfiguration": { "$ref": "#/types/aws:ecs/ClusterConfigurationExecuteCommandConfiguration:ClusterConfigurationExecuteCommandConfiguration", "description": "Details of the execute command configuration. See `execute_command_configuration` Block for details.\n" }, "managedStorageConfiguration": { "$ref": "#/types/aws:ecs/ClusterConfigurationManagedStorageConfiguration:ClusterConfigurationManagedStorageConfiguration", "description": "Details of the managed storage configuration. See `managed_storage_configuration` Block for details.\n" } }, "type": "object" }, "aws:ecs/ClusterConfigurationExecuteCommandConfiguration:ClusterConfigurationExecuteCommandConfiguration": { "properties": { "kmsKeyId": { "type": "string", "description": "AWS Key Management Service key ID to encrypt the data between the local client and the container.\n" }, "logConfiguration": { "$ref": "#/types/aws:ecs/ClusterConfigurationExecuteCommandConfigurationLogConfiguration:ClusterConfigurationExecuteCommandConfigurationLogConfiguration", "description": "Log configuration for the results of the execute command actions. Required when `logging` is `OVERRIDE`. See `log_configuration` Block for details.\n" }, "logging": { "type": "string", "description": "Log setting to use for redirecting logs for your execute command results. Valid values: `NONE`, `DEFAULT`, `OVERRIDE`.\n" } }, "type": "object" }, "aws:ecs/ClusterConfigurationExecuteCommandConfigurationLogConfiguration:ClusterConfigurationExecuteCommandConfigurationLogConfiguration": { "properties": { "cloudWatchEncryptionEnabled": { "type": "boolean", "description": "Whether to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.\n" }, "cloudWatchLogGroupName": { "type": "string", "description": "The name of the CloudWatch log group to send logs to.\n" }, "s3BucketEncryptionEnabled": { "type": "boolean", "description": "Whether to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.\n" }, "s3BucketName": { "type": "string", "description": "Name of the S3 bucket to send logs to.\n" }, "s3KeyPrefix": { "type": "string", "description": "Optional folder in the S3 bucket to place logs in.\n" } }, "type": "object" }, "aws:ecs/ClusterConfigurationManagedStorageConfiguration:ClusterConfigurationManagedStorageConfiguration": { "properties": { "fargateEphemeralStorageKmsKeyId": { "type": "string", "description": "AWS Key Management Service key ID for the Fargate ephemeral storage.\n" }, "kmsKeyId": { "type": "string", "description": "AWS Key Management Service key ID to encrypt the managed storage.\n" } }, "type": "object" }, "aws:ecs/ClusterServiceConnectDefaults:ClusterServiceConnectDefaults": { "properties": { "namespace": { "type": "string", "description": "ARN of the `aws.servicediscovery.HttpNamespace` that's used when you create a service and don't specify a Service Connect configuration.\n" } }, "type": "object", "required": [ "namespace" ] }, "aws:ecs/ClusterSetting:ClusterSetting": { "properties": { "name": { "type": "string", "description": "Name of the setting to manage. Valid values: `containerInsights`.\n" }, "value": { "type": "string", "description": "Value to assign to the setting. Valid values: `enhanced`, `enabled`, `disabled`.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:ecs/ServiceAlarms:ServiceAlarms": { "properties": { "alarmNames": { "type": "array", "items": { "type": "string" }, "description": "One or more CloudWatch alarm names.\n" }, "enable": { "type": "boolean", "description": "Whether to use the CloudWatch alarm option in the service deployment process.\n" }, "rollback": { "type": "boolean", "description": "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.\n" } }, "type": "object", "required": [ "alarmNames", "enable", "rollback" ] }, "aws:ecs/ServiceCapacityProviderStrategy:ServiceCapacityProviderStrategy": { "properties": { "base": { "type": "integer", "description": "Number of 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.\n" }, "capacityProvider": { "type": "string", "description": "Short name of the capacity provider.\n" }, "weight": { "type": "integer", "description": "Relative percentage of the total number of launched tasks that should use the specified capacity provider.\n" } }, "type": "object", "required": [ "capacityProvider" ] }, "aws:ecs/ServiceDeploymentCircuitBreaker:ServiceDeploymentCircuitBreaker": { "properties": { "enable": { "type": "boolean", "description": "Whether to enable the deployment circuit breaker logic for the service.\n" }, "rollback": { "type": "boolean", "description": "Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.\n" } }, "type": "object", "required": [ "enable", "rollback" ] }, "aws:ecs/ServiceDeploymentController:ServiceDeploymentController": { "properties": { "type": { "type": "string", "description": "Type of deployment controller. Valid values: `CODE_DEPLOY`, `ECS`, `EXTERNAL`. Default: `ECS`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ecs/ServiceLoadBalancer:ServiceLoadBalancer": { "properties": { "containerName": { "type": "string", "description": "Name of the container to associate with the load balancer (as it appears in a container definition).\n" }, "containerPort": { "type": "integer", "description": "Port on the container to associate with the load balancer.\n\n\u003e **Version note:** Multiple `load_balancer` configuration block support was added in version 2.22.0 of the provider. This allows configuration of [ECS service support for multiple target groups](https://aws.amazon.com/about-aws/whats-new/2019/07/amazon-ecs-services-now-support-multiple-load-balancer-target-groups/).\n" }, "elbName": { "type": "string", "description": "Name of the ELB (Classic) to associate with the service.\n" }, "targetGroupArn": { "type": "string", "description": "ARN of the Load Balancer target group to associate with the service.\n" } }, "type": "object", "required": [ "containerName", "containerPort" ] }, "aws:ecs/ServiceNetworkConfiguration:ServiceNetworkConfiguration": { "properties": { "assignPublicIp": { "type": "boolean", "description": "Assign a public IP address to the ENI (Fargate launch type only). Valid values are `true` or `false`. Default `false`.\n\nFor more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "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.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "Subnets associated with the task or service.\n" } }, "type": "object", "required": [ "subnets" ] }, "aws:ecs/ServiceOrderedPlacementStrategy:ServiceOrderedPlacementStrategy": { "properties": { "field": { "type": "string", "description": "For the `spread` placement strategy, valid values are `instanceId` (or `host`,\nwhich has the same effect), or any platform or custom attribute that is applied to a container instance.\nFor the `binpack` type, valid values are `memory` and `cpu`. For the `random` type, this attribute is not\nneeded. For more information, see [Placement Strategy](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementStrategy.html).\n\n\u003e **Note:** for `spread`, `host` and `instanceId` will be normalized, by AWS, to be `instanceId`. This means the statefile will show `instanceId` but your config will differ if you use `host`.\n" }, "type": { "type": "string", "description": "Type of placement strategy. Must be one of: `binpack`, `random`, or `spread`\n" } }, "type": "object", "required": [ "type" ] }, "aws:ecs/ServicePlacementConstraint:ServicePlacementConstraint": { "properties": { "expression": { "type": "string", "description": "Cluster Query Language expression to apply to the constraint. Does not need to be specified for the `distinctInstance` type. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).\n" }, "type": { "type": "string", "description": "Type of constraint. The only valid values at this time are `memberOf` and `distinctInstance`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:ecs/ServiceServiceConnectConfiguration:ServiceServiceConnectConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Whether to use Service Connect with this service.\n" }, "logConfiguration": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationLogConfiguration:ServiceServiceConnectConfigurationLogConfiguration", "description": "Log configuration for the container. See below.\n" }, "namespace": { "type": "string", "description": "Namespace name or ARN of the `aws.servicediscovery.HttpNamespace` for use with Service Connect.\n" }, "services": { "type": "array", "items": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationService:ServiceServiceConnectConfigurationService" }, "description": "List of Service Connect service objects. See below.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "enabled", "namespace" ] } } }, "aws:ecs/ServiceServiceConnectConfigurationLogConfiguration:ServiceServiceConnectConfigurationLogConfiguration": { "properties": { "logDriver": { "type": "string", "description": "Log driver to use for the container.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Configuration options to send to the log driver.\n" }, "secretOptions": { "type": "array", "items": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationLogConfigurationSecretOption:ServiceServiceConnectConfigurationLogConfigurationSecretOption" }, "description": "Secrets to pass to the log configuration. See below.\n" } }, "type": "object", "required": [ "logDriver" ], "language": { "nodejs": { "requiredOutputs": [ "logDriver", "options" ] } } }, "aws:ecs/ServiceServiceConnectConfigurationLogConfigurationSecretOption:ServiceServiceConnectConfigurationLogConfigurationSecretOption": { "properties": { "name": { "type": "string", "description": "Name of the secret.\n" }, "valueFrom": { "type": "string", "description": "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" } }, "type": "object", "required": [ "name", "valueFrom" ] }, "aws:ecs/ServiceServiceConnectConfigurationService:ServiceServiceConnectConfigurationService": { "properties": { "clientAlias": { "type": "array", "items": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationServiceClientAlias:ServiceServiceConnectConfigurationServiceClientAlias" }, "description": "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. See below.\n" }, "discoveryName": { "type": "string", "description": "Name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.\n" }, "ingressPortOverride": { "type": "integer", "description": "Port number for the Service Connect proxy to listen on.\n" }, "portName": { "type": "string", "description": "Name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.\n" }, "timeout": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationServiceTimeout:ServiceServiceConnectConfigurationServiceTimeout", "description": "Configuration timeouts for Service Connect\n" }, "tls": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationServiceTls:ServiceServiceConnectConfigurationServiceTls", "description": "Configuration for enabling Transport Layer Security (TLS)\n" } }, "type": "object", "required": [ "portName" ], "language": { "nodejs": { "requiredOutputs": [ "discoveryName", "portName" ] } } }, "aws:ecs/ServiceServiceConnectConfigurationServiceClientAlias:ServiceServiceConnectConfigurationServiceClientAlias": { "properties": { "dnsName": { "type": "string", "description": "Name that you use in the applications of client tasks to connect to this service.\n" }, "port": { "type": "integer", "description": "Listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n" } }, "type": "object", "required": [ "port" ], "language": { "nodejs": { "requiredOutputs": [ "dnsName", "port" ] } } }, "aws:ecs/ServiceServiceConnectConfigurationServiceTimeout:ServiceServiceConnectConfigurationServiceTimeout": { "properties": { "idleTimeoutSeconds": { "type": "integer", "description": "Amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.\n" }, "perRequestTimeoutSeconds": { "type": "integer", "description": "Amount of time in seconds for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout. Can only be set when appProtocol isn't TCP.\n" } }, "type": "object" }, "aws:ecs/ServiceServiceConnectConfigurationServiceTls:ServiceServiceConnectConfigurationServiceTls": { "properties": { "issuerCertAuthority": { "$ref": "#/types/aws:ecs/ServiceServiceConnectConfigurationServiceTlsIssuerCertAuthority:ServiceServiceConnectConfigurationServiceTlsIssuerCertAuthority", "description": "Details of the certificate authority which will issue the certificate.\n" }, "kmsKey": { "type": "string", "description": "KMS key used to encrypt the private key in Secrets Manager.\n" }, "roleArn": { "type": "string", "description": "ARN of the IAM Role that's associated with the Service Connect TLS.\n" } }, "type": "object", "required": [ "issuerCertAuthority" ] }, "aws:ecs/ServiceServiceConnectConfigurationServiceTlsIssuerCertAuthority:ServiceServiceConnectConfigurationServiceTlsIssuerCertAuthority": { "properties": { "awsPcaAuthorityArn": { "type": "string", "description": "ARN of the `aws.acmpca.CertificateAuthority` used to create the TLS Certificates.\n" } }, "type": "object", "required": [ "awsPcaAuthorityArn" ] }, "aws:ecs/ServiceServiceRegistries:ServiceServiceRegistries": { "properties": { "containerName": { "type": "string", "description": "Container name value, already specified in the task definition, to be used for your service discovery service.\n" }, "containerPort": { "type": "integer", "description": "Port value, already specified in the task definition, to be used for your service discovery service.\n" }, "port": { "type": "integer", "description": "Port value used if your Service Discovery service specified an SRV record.\n" }, "registryArn": { "type": "string", "description": "ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(`aws.servicediscovery.Service`). For more information, see [Service](https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html)\n" } }, "type": "object", "required": [ "registryArn" ] }, "aws:ecs/ServiceVolumeConfiguration:ServiceVolumeConfiguration": { "properties": { "managedEbsVolume": { "$ref": "#/types/aws:ecs/ServiceVolumeConfigurationManagedEbsVolume:ServiceVolumeConfigurationManagedEbsVolume", "description": "Configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. See below.\n" }, "name": { "type": "string", "description": "Name of the volume.\n" } }, "type": "object", "required": [ "managedEbsVolume", "name" ] }, "aws:ecs/ServiceVolumeConfigurationManagedEbsVolume:ServiceVolumeConfigurationManagedEbsVolume": { "properties": { "encrypted": { "type": "boolean", "description": "Whether the volume should be encrypted. Default value is `true`.\n" }, "fileSystemType": { "type": "string", "description": "Linux filesystem type for the volume. For volumes created from a snapshot, same filesystem type must be specified that the volume was using when the snapshot was created. Valid values are `ext3`, `ext4`, `xfs`. Default value is `xfs`.\n" }, "iops": { "type": "integer", "description": "Number of I/O operations per second (IOPS).\n" }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption.\n" }, "roleArn": { "type": "string", "description": "Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. Recommended using the Amazon ECS-managed `AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role.\n" }, "sizeInGb": { "type": "integer", "description": "Size of the volume in GiB. You must specify either a `size_in_gb` or a `snapshot_id`. You can optionally specify a volume size greater than or equal to the snapshot size.\n" }, "snapshotId": { "type": "string", "description": "Snapshot that Amazon ECS uses to create the volume. You must specify either a `size_in_gb` or a `snapshot_id`.\n" }, "tagSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:ecs/ServiceVolumeConfigurationManagedEbsVolumeTagSpecification:ServiceVolumeConfigurationManagedEbsVolumeTagSpecification" }, "description": "The tags to apply to the volume. See below.\n" }, "throughput": { "type": "integer", "description": "Throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n" }, "volumeType": { "type": "string", "description": "Volume type.\n" } }, "type": "object", "required": [ "roleArn" ] }, "aws:ecs/ServiceVolumeConfigurationManagedEbsVolumeTagSpecification:ServiceVolumeConfigurationManagedEbsVolumeTagSpecification": { "properties": { "propagateTags": { "type": "string", "description": "Determines whether to propagate the tags from the task definition to the Amazon EBS volume.\n" }, "resourceType": { "type": "string", "description": "The type of volume resource. Valid values, `volume`.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The tags applied to this Amazon EBS volume. `AmazonECSCreated` and `AmazonECSManaged` are reserved tags that can't be used.\n" } }, "type": "object", "required": [ "resourceType" ] }, "aws:ecs/ServiceVpcLatticeConfiguration:ServiceVpcLatticeConfiguration": { "properties": { "portName": { "type": "string", "description": "The name of the port for a target group associated with the VPC Lattice configuration.\n" }, "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.\n" }, "targetGroupArn": { "type": "string", "description": "The full ARN of the target group or groups associated with the VPC Lattice configuration.\n" } }, "type": "object", "required": [ "portName", "roleArn", "targetGroupArn" ] }, "aws:ecs/TaskDefinitionEphemeralStorage:TaskDefinitionEphemeralStorage": { "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.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sizeInGib" ] }, "aws:ecs/TaskDefinitionInferenceAccelerator:TaskDefinitionInferenceAccelerator": { "properties": { "deviceName": { "type": "string", "description": "Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.\n", "willReplaceOnChanges": true }, "deviceType": { "type": "string", "description": "Elastic Inference accelerator type to use.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "deviceName", "deviceType" ] }, "aws:ecs/TaskDefinitionPlacementConstraint:TaskDefinitionPlacementConstraint": { "properties": { "expression": { "type": "string", "description": "Cluster Query Language expression to apply to the constraint. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of constraint. Use `memberOf` to restrict selection to a group of valid candidates. Note that `distinctInstance` is not supported in task definitions.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "aws:ecs/TaskDefinitionProxyConfiguration:TaskDefinitionProxyConfiguration": { "properties": { "containerName": { "type": "string", "description": "Name of the container that will serve as the App Mesh proxy.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Proxy type. The default value is `APPMESH`. The only supported value is `APPMESH`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "containerName" ] }, "aws:ecs/TaskDefinitionRuntimePlatform:TaskDefinitionRuntimePlatform": { "properties": { "cpuArchitecture": { "type": "string", "description": "Must be set to either `X86_64` or `ARM64`; see [cpu architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform)\n", "willReplaceOnChanges": true }, "operatingSystemFamily": { "type": "string", "description": "If the `requires_compatibilities` is `FARGATE` this field is required; must be set to a valid option from the [operating system family in the runtime platform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) setting\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ecs/TaskDefinitionVolume:TaskDefinitionVolume": { "properties": { "configureAtLaunch": { "type": "boolean", "description": "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", "willReplaceOnChanges": true }, "dockerVolumeConfiguration": { "$ref": "#/types/aws:ecs/TaskDefinitionVolumeDockerVolumeConfiguration:TaskDefinitionVolumeDockerVolumeConfiguration", "description": "Configuration block to configure a docker volume. Detailed below.\n", "willReplaceOnChanges": true }, "efsVolumeConfiguration": { "$ref": "#/types/aws:ecs/TaskDefinitionVolumeEfsVolumeConfiguration:TaskDefinitionVolumeEfsVolumeConfiguration", "description": "Configuration block for an EFS volume. Detailed below.\n", "willReplaceOnChanges": true }, "fsxWindowsFileServerVolumeConfiguration": { "$ref": "#/types/aws:ecs/TaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration:TaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration", "description": "Configuration block for an FSX Windows File Server volume. Detailed below.\n", "willReplaceOnChanges": true }, "hostPath": { "type": "string", "description": "Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the volume. This name is referenced in the `sourceVolume`\nparameter of container definition in the `mountPoints` section.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "configureAtLaunch", "name" ] } } }, "aws:ecs/TaskDefinitionVolumeDockerVolumeConfiguration:TaskDefinitionVolumeDockerVolumeConfiguration": { "properties": { "autoprovision": { "type": "boolean", "description": "If this value is `true`, the Docker volume is created if it does not already exist. *Note*: This field is only used if the scope is `shared`.\n", "willReplaceOnChanges": true }, "driver": { "type": "string", "description": "Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.\n", "willReplaceOnChanges": true }, "driverOpts": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of Docker driver specific options.\n", "willReplaceOnChanges": true }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of custom metadata to add to your Docker volume.\n", "willReplaceOnChanges": true }, "scope": { "type": "string", "description": "Scope for the Docker volume, which determines its lifecycle, either `task` or `shared`. 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.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driver", "scope" ] } } }, "aws:ecs/TaskDefinitionVolumeEfsVolumeConfiguration:TaskDefinitionVolumeEfsVolumeConfiguration": { "properties": { "authorizationConfig": { "$ref": "#/types/aws:ecs/TaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig:TaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig", "description": "Configuration block for authorization for the Amazon EFS file system. Detailed below.\n", "willReplaceOnChanges": true }, "fileSystemId": { "type": "string", "description": "ID of the EFS File System.\n", "willReplaceOnChanges": true }, "rootDirectory": { "type": "string", "description": "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. This argument is ignored when using `authorization_config`.\n", "willReplaceOnChanges": true }, "transitEncryption": { "type": "string", "description": "Whether or not 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. Valid values: `ENABLED`, `DISABLED`. If this parameter is omitted, the default value of `DISABLED` is used.\n", "willReplaceOnChanges": true }, "transitEncryptionPort": { "type": "integer", "description": "Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "fileSystemId" ] }, "aws:ecs/TaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig:TaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig": { "properties": { "accessPointId": { "type": "string", "description": "Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.\n", "willReplaceOnChanges": true }, "iam": { "type": "string", "description": "Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: `ENABLED`, `DISABLED`. If this parameter is omitted, the default value of `DISABLED` is used.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:ecs/TaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration:TaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration": { "properties": { "authorizationConfig": { "$ref": "#/types/aws:ecs/TaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig:TaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig", "description": "Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.\n", "willReplaceOnChanges": true }, "fileSystemId": { "type": "string", "description": "The Amazon FSx for Windows File Server file system ID to use.\n", "willReplaceOnChanges": true }, "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.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "authorizationConfig", "fileSystemId", "rootDirectory" ] }, "aws:ecs/TaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig:TaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig": { "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 AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.\n", "willReplaceOnChanges": true }, "domain": { "type": "string", "description": "A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "credentialsParameter", "domain" ] }, "aws:ecs/TaskSetCapacityProviderStrategy:TaskSetCapacityProviderStrategy": { "properties": { "base": { "type": "integer", "description": "The number of 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.\n", "willReplaceOnChanges": true }, "capacityProvider": { "type": "string", "description": "The short name or full Amazon Resource Name (ARN) of the capacity provider.\n", "willReplaceOnChanges": true }, "weight": { "type": "integer", "description": "The relative percentage of the total number of launched tasks that should use the specified capacity provider.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "capacityProvider", "weight" ] }, "aws:ecs/TaskSetLoadBalancer:TaskSetLoadBalancer": { "properties": { "containerName": { "type": "string", "description": "The name of the container to associate with the load balancer (as it appears in a container definition).\n", "willReplaceOnChanges": true }, "containerPort": { "type": "integer", "description": "The port on the container to associate with the load balancer. Defaults to `0` if not specified.\n\n\u003e **Note:** Specifying multiple `load_balancer` configurations is still not supported by AWS for ECS task set.\n", "willReplaceOnChanges": true }, "loadBalancerName": { "type": "string", "description": "The name of the ELB (Classic) to associate with the service.\n", "willReplaceOnChanges": true }, "targetGroupArn": { "type": "string", "description": "The ARN of the Load Balancer target group to associate with the service.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "containerName" ] }, "aws:ecs/TaskSetNetworkConfiguration:TaskSetNetworkConfiguration": { "properties": { "assignPublicIp": { "type": "boolean", "description": "Whether to assign a public IP address to the ENI (`FARGATE` launch type only). Valid values are `true` or `false`. Default `false`.\n\nFor more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html).\n", "willReplaceOnChanges": true }, "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. Maximum of 5.\n", "willReplaceOnChanges": true }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The subnets associated with the task or service. Maximum of 16.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnets" ] }, "aws:ecs/TaskSetScale:TaskSetScale": { "properties": { "unit": { "type": "string", "description": "The unit of measure for the scale value. Default: `PERCENT`.\n" }, "value": { "type": "number", "description": "The value, specified as a percent total of a service's `desiredCount`, to scale the task set. Defaults to `0` if not specified. Accepted values are numbers between 0.0 and 100.0.\n" } }, "type": "object" }, "aws:ecs/TaskSetServiceRegistries:TaskSetServiceRegistries": { "properties": { "containerName": { "type": "string", "description": "The container name value, already specified in the task definition, to be used for your service discovery service.\n", "willReplaceOnChanges": true }, "containerPort": { "type": "integer", "description": "The port value, already specified in the task definition, to be used for your service discovery service.\n", "willReplaceOnChanges": true }, "port": { "type": "integer", "description": "The port value used if your Service Discovery service specified an SRV record.\n", "willReplaceOnChanges": true }, "registryArn": { "type": "string", "description": "The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(`aws.servicediscovery.Service` resource). For more information, see [Service](https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "registryArn" ] }, "aws:ecs/getClusterServiceConnectDefault:getClusterServiceConnectDefault": { "properties": { "namespace": { "type": "string" } }, "type": "object", "required": [ "namespace" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getClusterSetting:getClusterSetting": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionEphemeralStorage:getTaskDefinitionEphemeralStorage": { "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.\n" } }, "type": "object", "required": [ "sizeInGib" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionInferenceAccelerator:getTaskDefinitionInferenceAccelerator": { "properties": { "deviceName": { "type": "string", "description": "Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.\n" }, "deviceType": { "type": "string", "description": "Elastic Inference accelerator type to use.\n" } }, "type": "object", "required": [ "deviceName", "deviceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionPlacementConstraint:getTaskDefinitionPlacementConstraint": { "properties": { "expression": { "type": "string", "description": "Cluster Query Language expression to apply to the constraint. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).\n" }, "type": { "type": "string", "description": "Proxy type. The default value is `APPMESH`. The only supported value is `APPMESH`.\n" } }, "type": "object", "required": [ "expression", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionProxyConfiguration:getTaskDefinitionProxyConfiguration": { "properties": { "containerName": { "type": "string", "description": "Name of the container that will serve as the App Mesh proxy.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.\n" }, "type": { "type": "string", "description": "Proxy type. The default value is `APPMESH`. The only supported value is `APPMESH`.\n" } }, "type": "object", "required": [ "containerName", "properties", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionRuntimePlatform:getTaskDefinitionRuntimePlatform": { "properties": { "cpuArchitecture": { "type": "string", "description": "Must be set to either `X86_64` or `ARM64`; see [cpu architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform)\n" }, "operatingSystemFamily": { "type": "string", "description": "If the `requires_compatibilities` is `FARGATE` this field is required; must be set to a valid option from the [operating system family in the runtime platform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) setting\n" } }, "type": "object", "required": [ "cpuArchitecture", "operatingSystemFamily" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolume:getTaskDefinitionVolume": { "properties": { "configureAtLaunch": { "type": "boolean", "description": "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" }, "dockerVolumeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskDefinitionVolumeDockerVolumeConfiguration:getTaskDefinitionVolumeDockerVolumeConfiguration" }, "description": "Configuration block to configure a docker volume. Detailed below.\n" }, "efsVolumeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskDefinitionVolumeEfsVolumeConfiguration:getTaskDefinitionVolumeEfsVolumeConfiguration" }, "description": "Configuration block for an EFS volume. Detailed below.\n" }, "fsxWindowsFileServerVolumeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration:getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration" }, "description": "Configuration block for an FSX Windows File Server volume. Detailed below.\n" }, "hostPath": { "type": "string", "description": "Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.\n" }, "name": { "type": "string", "description": "Name of the volume. This name is referenced in the `sourceVolume`\nparameter of container definition in the `mountPoints` section.\n" } }, "type": "object", "required": [ "configureAtLaunch", "dockerVolumeConfigurations", "efsVolumeConfigurations", "fsxWindowsFileServerVolumeConfigurations", "hostPath", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolumeDockerVolumeConfiguration:getTaskDefinitionVolumeDockerVolumeConfiguration": { "properties": { "autoprovision": { "type": "boolean", "description": "If this value is `true`, the Docker volume is created if it does not already exist. *Note*: This field is only used if the scope is `shared`.\n" }, "driver": { "type": "string", "description": "Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.\n" }, "driverOpts": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of Docker driver specific options.\n" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of custom metadata to add to your Docker volume.\n" }, "scope": { "type": "string", "description": "Scope for the Docker volume, which determines its lifecycle, either `task` or `shared`. 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.\n" } }, "type": "object", "required": [ "autoprovision", "driver", "driverOpts", "labels", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolumeEfsVolumeConfiguration:getTaskDefinitionVolumeEfsVolumeConfiguration": { "properties": { "authorizationConfigs": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig:getTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig" }, "description": "Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.\n" }, "fileSystemId": { "type": "string", "description": "The Amazon FSx for Windows File Server file system ID to use.\n" }, "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.\n" }, "transitEncryption": { "type": "string", "description": "Whether or not 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. Valid values: `ENABLED`, `DISABLED`. If this parameter is omitted, the default value of `DISABLED` is used.\n" }, "transitEncryptionPort": { "type": "integer", "description": "Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.\n" } }, "type": "object", "required": [ "authorizationConfigs", "fileSystemId", "rootDirectory", "transitEncryption", "transitEncryptionPort" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig:getTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig": { "properties": { "accessPointId": { "type": "string", "description": "Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.\n" }, "iam": { "type": "string", "description": "Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: `ENABLED`, `DISABLED`. If this parameter is omitted, the default value of `DISABLED` is used.\n" } }, "type": "object", "required": [ "accessPointId", "iam" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration:getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration": { "properties": { "authorizationConfigs": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig:getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig" }, "description": "Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.\n" }, "fileSystemId": { "type": "string", "description": "The Amazon FSx for Windows File Server file system ID to use.\n" }, "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.\n" } }, "type": "object", "required": [ "authorizationConfigs", "fileSystemId", "rootDirectory" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig:getTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig": { "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 AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.\n" }, "domain": { "type": "string", "description": "A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.\n" } }, "type": "object", "required": [ "credentialsParameter", "domain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:ecs/getTaskExecutionCapacityProviderStrategy:getTaskExecutionCapacityProviderStrategy": { "properties": { "base": { "type": "integer", "description": "The number of 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. Defaults to `0`.\n" }, "capacityProvider": { "type": "string", "description": "Name of the capacity provider.\n" }, "weight": { "type": "integer", "description": "The relative percentage of the total number of launched tasks that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` count of tasks has been satisfied. Defaults to `0`.\n" } }, "type": "object", "required": [ "capacityProvider" ] }, "aws:ecs/getTaskExecutionNetworkConfiguration:getTaskExecutionNetworkConfiguration": { "properties": { "assignPublicIp": { "type": "boolean", "description": "Assign a public IP address to the ENI (Fargate launch type only). Valid values are `true` or `false`. Default `false`.\n\nFor more information, see the [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) documentation.\n" }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "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.\n" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "Subnets associated with the task or service.\n" } }, "type": "object", "required": [ "subnets" ] }, "aws:ecs/getTaskExecutionOverrides:getTaskExecutionOverrides": { "properties": { "containerOverrides": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskExecutionOverridesContainerOverride:getTaskExecutionOverridesContainerOverride" }, "description": "One or more container overrides that are sent to a task. See below.\n" }, "cpu": { "type": "string", "description": "The CPU override for the task.\n" }, "executionRoleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the task execution role override for the task.\n" }, "inferenceAcceleratorOverrides": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskExecutionOverridesInferenceAcceleratorOverride:getTaskExecutionOverridesInferenceAcceleratorOverride" }, "description": "**DEPRECATED** Elastic Inference accelerator override for the task. See below.\n", "deprecationMessage": "inference_accelerator_overrides is deprecated. AWS no longer supports the Elastic Inference service." }, "memory": { "type": "string", "description": "The memory override for the task.\n" }, "taskRoleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the role that containers in this task can assume.\n" } }, "type": "object" }, "aws:ecs/getTaskExecutionOverridesContainerOverride:getTaskExecutionOverridesContainerOverride": { "properties": { "commands": { "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.\n" }, "cpu": { "type": "integer", "description": "The number of cpu units reserved for the container, instead of the default value from the task definition.\n" }, "environments": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskExecutionOverridesContainerOverrideEnvironment:getTaskExecutionOverridesContainerOverrideEnvironment" }, "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. See below.\n" }, "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.\n" }, "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.\n" }, "name": { "type": "string", "description": "The name of the container that receives the override. This parameter is required if any override is specified.\n" }, "resourceRequirements": { "type": "array", "items": { "$ref": "#/types/aws:ecs/getTaskExecutionOverridesContainerOverrideResourceRequirement:getTaskExecutionOverridesContainerOverrideResourceRequirement" }, "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. See below.\n" } }, "type": "object", "required": [ "name" ] }, "aws:ecs/getTaskExecutionOverridesContainerOverrideEnvironment:getTaskExecutionOverridesContainerOverrideEnvironment": { "properties": { "key": { "type": "string", "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable.\n" }, "value": { "type": "string", "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:ecs/getTaskExecutionOverridesContainerOverrideResourceRequirement:getTaskExecutionOverridesContainerOverrideResourceRequirement": { "properties": { "type": { "type": "string", "description": "The type of resource to assign to a container. Valid values are `GPU` or `InferenceAccelerator`.\n" }, "value": { "type": "string", "description": "The value for the specified resource type. If 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. If the `InferenceAccelerator` type is used, the value matches the `deviceName` for an InferenceAccelerator specified in a task definition.\n" } }, "type": "object", "required": [ "type", "value" ] }, "aws:ecs/getTaskExecutionOverridesInferenceAcceleratorOverride:getTaskExecutionOverridesInferenceAcceleratorOverride": { "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.\n" }, "deviceType": { "type": "string", "description": "The Elastic Inference accelerator type to use.\n" } }, "type": "object" }, "aws:ecs/getTaskExecutionPlacementConstraint:getTaskExecutionPlacementConstraint": { "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`.\n" }, "type": { "type": "string", "description": "The type of constraint. Valid values are `distinctInstance` or `memberOf`. 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.\n" } }, "type": "object", "required": [ "type" ] }, "aws:ecs/getTaskExecutionPlacementStrategy:getTaskExecutionPlacementStrategy": { "properties": { "field": { "type": "string", "description": "The field to apply the placement strategy against.\n" }, "type": { "type": "string", "description": "The type of placement strategy. Valid values are `random`, `spread`, and `binpack`.\n\nFor more information, see the [Placement Strategy](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementStrategy.html) documentation.\n" } }, "type": "object", "required": [ "type" ] }, "aws:efs/AccessPointPosixUser:AccessPointPosixUser": { "properties": { "gid": { "type": "integer", "description": "POSIX group ID used for all file system operations using this access point.\n", "willReplaceOnChanges": true }, "secondaryGids": { "type": "array", "items": { "type": "integer" }, "description": "Secondary POSIX group IDs used for all file system operations using this access point.\n", "willReplaceOnChanges": true }, "uid": { "type": "integer", "description": "POSIX user ID used for all file system operations using this access point.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "gid", "uid" ] }, "aws:efs/AccessPointRootDirectory:AccessPointRootDirectory": { "properties": { "creationInfo": { "$ref": "#/types/aws:efs/AccessPointRootDirectoryCreationInfo:AccessPointRootDirectoryCreationInfo", "description": "POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.\n", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "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 `creation_info`.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creationInfo", "path" ] } } }, "aws:efs/AccessPointRootDirectoryCreationInfo:AccessPointRootDirectoryCreationInfo": { "properties": { "ownerGid": { "type": "integer", "description": "POSIX group ID to apply to the `root_directory`.\n", "willReplaceOnChanges": true }, "ownerUid": { "type": "integer", "description": "POSIX user ID to apply to the `root_directory`.\n", "willReplaceOnChanges": true }, "permissions": { "type": "string", "description": "POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "ownerGid", "ownerUid", "permissions" ] }, "aws:efs/BackupPolicyBackupPolicy:BackupPolicyBackupPolicy": { "properties": { "status": { "type": "string", "description": "A status of the backup policy. Valid values: `ENABLED`, `DISABLED`.\n" } }, "type": "object", "required": [ "status" ] }, "aws:efs/FileSystemLifecyclePolicy:FileSystemLifecyclePolicy": { "properties": { "transitionToArchive": { "type": "string", "description": "Indicates how long it takes to transition files to the archive storage class. Requires transition_to_ia, Elastic Throughput and General Purpose performance mode. Valid values: `AFTER_1_DAY`, `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, `AFTER_90_DAYS`, `AFTER_180_DAYS`, `AFTER_270_DAYS`, or `AFTER_365_DAYS`.\n" }, "transitionToIa": { "type": "string", "description": "Indicates how long it takes to transition files to the IA storage class. Valid values: `AFTER_1_DAY`, `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, `AFTER_90_DAYS`, `AFTER_180_DAYS`, `AFTER_270_DAYS`, or `AFTER_365_DAYS`.\n" }, "transitionToPrimaryStorageClass": { "type": "string", "description": "Describes the policy used to transition a file from infequent access storage to primary storage. Valid values: `AFTER_1_ACCESS`.\n" } }, "type": "object" }, "aws:efs/FileSystemProtection:FileSystemProtection": { "properties": { "replicationOverwrite": { "type": "string", "description": "Indicates whether replication overwrite protection is enabled. Valid values: `ENABLED` or `DISABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "replicationOverwrite" ] } } }, "aws:efs/FileSystemSizeInByte:FileSystemSizeInByte": { "properties": { "value": { "type": "integer", "description": "The latest known metered size (in bytes) of data stored in the file system.\n" }, "valueInIa": { "type": "integer", "description": "The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.\n" }, "valueInStandard": { "type": "integer", "description": "The latest known metered size (in bytes) of data stored in the Standard storage class.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "value", "valueInIa", "valueInStandard" ] } } }, "aws:efs/ReplicationConfigurationDestination:ReplicationConfigurationDestination": { "properties": { "availabilityZoneName": { "type": "string", "description": "The availability zone in which the replica should be created. If specified, the replica will be created with One Zone storage. If omitted, regional storage will be used.\n", "willReplaceOnChanges": true }, "fileSystemId": { "type": "string", "description": "The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The Key ID, ARN, alias, or alias ARN of the KMS key that should be used to encrypt the replica file system. If omitted, the default KMS key for EFS `/aws/elasticfilesystem` will be used.\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "The region in which the replica should be created.\n", "willReplaceOnChanges": true }, "status": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fileSystemId", "region", "status" ] } } }, "aws:efs/getAccessPointPosixUser:getAccessPointPosixUser": { "properties": { "gid": { "type": "integer", "description": "Group ID\n" }, "secondaryGids": { "type": "array", "items": { "type": "integer" }, "description": "Secondary group IDs\n" }, "uid": { "type": "integer", "description": "User Id\n" } }, "type": "object", "required": [ "gid", "secondaryGids", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:efs/getAccessPointRootDirectory:getAccessPointRootDirectory": { "properties": { "creationInfos": { "type": "array", "items": { "$ref": "#/types/aws:efs/getAccessPointRootDirectoryCreationInfo:getAccessPointRootDirectoryCreationInfo" }, "description": "Single element list containing information on the creation permissions of the directory\n" }, "path": { "type": "string", "description": "Path exposed as the root directory\n" } }, "type": "object", "required": [ "creationInfos", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:efs/getAccessPointRootDirectoryCreationInfo:getAccessPointRootDirectoryCreationInfo": { "properties": { "ownerGid": { "type": "integer", "description": "POSIX owner group ID\n" }, "ownerUid": { "type": "integer", "description": "POSIX owner user ID\n" }, "permissions": { "type": "string", "description": "POSIX permissions mode\n" } }, "type": "object", "required": [ "ownerGid", "ownerUid", "permissions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:efs/getFileSystemLifecyclePolicy:getFileSystemLifecyclePolicy": { "properties": { "transitionToArchive": { "type": "string" }, "transitionToIa": { "type": "string" }, "transitionToPrimaryStorageClass": { "type": "string" } }, "type": "object", "required": [ "transitionToArchive", "transitionToIa", "transitionToPrimaryStorageClass" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:efs/getFileSystemProtection:getFileSystemProtection": { "properties": { "replicationOverwrite": { "type": "string" } }, "type": "object", "required": [ "replicationOverwrite" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/AccessPolicyAssociationAccessScope:AccessPolicyAssociationAccessScope": { "properties": { "namespaces": { "type": "array", "items": { "type": "string" }, "description": "The namespaces to which the access scope applies when type is namespace.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Valid values are `namespace` or `cluster`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "aws:eks/AddonPodIdentityAssociation:AddonPodIdentityAssociation": { "properties": { "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the pods that use this service account.\n" }, "serviceAccount": { "type": "string", "description": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.\n" } }, "type": "object", "required": [ "roleArn", "serviceAccount" ] }, "aws:eks/ClusterAccessConfig:ClusterAccessConfig": { "properties": { "authenticationMode": { "type": "string", "description": "The authentication mode for the cluster. Valid values are `CONFIG_MAP`, `API` or `API_AND_CONFIG_MAP`\n" }, "bootstrapClusterCreatorAdminPermissions": { "type": "boolean", "description": "Whether or not to bootstrap the access config values to the cluster. Default is `false`.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authenticationMode" ] } } }, "aws:eks/ClusterCertificateAuthority:ClusterCertificateAuthority": { "properties": { "data": { "type": "string", "description": "Base64 encoded certificate data required to communicate with your cluster. Add this to the `certificate-authority-data` section of the `kubeconfig` file for your cluster.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "data" ] } } }, "aws:eks/ClusterComputeConfig:ClusterComputeConfig": { "properties": { "enabled": { "type": "boolean", "description": "Request to enable or disable the compute capability on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.\n" }, "nodePools": { "type": "array", "items": { "type": "string" }, "description": "Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. Valid options are `general-purpose` and `system`.\n" }, "nodeRoleArn": { "type": "string", "description": "The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled..\n" } }, "type": "object" }, "aws:eks/ClusterEncryptionConfig:ClusterEncryptionConfig": { "properties": { "provider": { "$ref": "#/types/aws:eks/ClusterEncryptionConfigProvider:ClusterEncryptionConfigProvider", "description": "Configuration block with provider for encryption. Detailed below.\n" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "List of strings with resources to be encrypted. Valid values: `secrets`.\n" } }, "type": "object", "required": [ "provider", "resources" ] }, "aws:eks/ClusterEncryptionConfigProvider:ClusterEncryptionConfigProvider": { "properties": { "keyArn": { "type": "string", "description": "ARN of the Key Management Service (KMS) customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see [Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html).\n" } }, "type": "object", "required": [ "keyArn" ] }, "aws:eks/ClusterIdentity:ClusterIdentity": { "properties": { "oidcs": { "type": "array", "items": { "$ref": "#/types/aws:eks/ClusterIdentityOidc:ClusterIdentityOidc" }, "description": "Nested block containing [OpenID Connect](https://openid.net/connect/) identity provider information for the cluster. Detailed below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "oidcs" ] } } }, "aws:eks/ClusterIdentityOidc:ClusterIdentityOidc": { "properties": { "issuer": { "type": "string", "description": "Issuer URL for the OpenID Connect identity provider.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "issuer" ] } } }, "aws:eks/ClusterKubernetesNetworkConfig:ClusterKubernetesNetworkConfig": { "properties": { "elasticLoadBalancing": { "$ref": "#/types/aws:eks/ClusterKubernetesNetworkConfigElasticLoadBalancing:ClusterKubernetesNetworkConfigElasticLoadBalancing", "description": "Configuration block with elastic load balancing configuration for the cluster. Detailed below.\n" }, "ipFamily": { "type": "string", "description": "The IP family used to assign Kubernetes pod and service addresses. Valid values are `ipv4` (default) and `ipv6`. You can only specify an IP family when you create a cluster, changing this value will force a new cluster to be created.\n", "willReplaceOnChanges": true }, "serviceIpv4Cidr": { "type": "string", "description": "The CIDR block to assign Kubernetes pod and 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. You can only specify a custom CIDR block when you create a cluster, changing this value will force a new cluster to be created. The block must meet the following requirements:\n\n* Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.\n\n* Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.\n\n* Between /24 and /12.\n", "willReplaceOnChanges": true }, "serviceIpv6Cidr": { "type": "string", "description": "The CIDR block that Kubernetes pod and service IP addresses are assigned from if you specify `ipv6` for `ip_family` when you create the cluster. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "elasticLoadBalancing", "ipFamily", "serviceIpv4Cidr", "serviceIpv6Cidr" ] } } }, "aws:eks/ClusterKubernetesNetworkConfigElasticLoadBalancing:ClusterKubernetesNetworkConfigElasticLoadBalancing": { "properties": { "enabled": { "type": "boolean", "description": "Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.\n" } }, "type": "object" }, "aws:eks/ClusterOutpostConfig:ClusterOutpostConfig": { "properties": { "controlPlaneInstanceType": { "type": "string", "description": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. Choose an instance type based on the number of nodes that your cluster will have. If your cluster will have:\n\n* 1–20 nodes, then we recommend specifying a large instance type.\n\n* 21–100 nodes, then we recommend specifying an xlarge instance type.\n\n* 101–250 nodes, then we recommend specifying a 2xlarge instance type.\n\nFor a list of the available Amazon EC2 instance types, see Compute and storage in AWS Outposts rack features The control plane is not automatically scaled by Amazon EKS.\n", "willReplaceOnChanges": true }, "controlPlanePlacement": { "$ref": "#/types/aws:eks/ClusterOutpostConfigControlPlanePlacement:ClusterOutpostConfigControlPlanePlacement", "description": "An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.\nThe `control_plane_placement` configuration block supports the following arguments:\n" }, "outpostArns": { "type": "array", "items": { "type": "string" }, "description": "The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. This argument is a list of arns, but only a single Outpost ARN is supported currently.\n" } }, "type": "object", "required": [ "controlPlaneInstanceType", "outpostArns" ] }, "aws:eks/ClusterOutpostConfigControlPlanePlacement:ClusterOutpostConfigControlPlanePlacement": { "properties": { "groupName": { "type": "string", "description": "The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "groupName" ] }, "aws:eks/ClusterRemoteNetworkConfig:ClusterRemoteNetworkConfig": { "properties": { "remoteNodeNetworks": { "$ref": "#/types/aws:eks/ClusterRemoteNetworkConfigRemoteNodeNetworks:ClusterRemoteNetworkConfigRemoteNodeNetworks", "description": "Configuration block with remote node network configuration for EKS Hybrid Nodes. Detailed below.\n" }, "remotePodNetworks": { "$ref": "#/types/aws:eks/ClusterRemoteNetworkConfigRemotePodNetworks:ClusterRemoteNetworkConfigRemotePodNetworks", "description": "Configuration block with remote pod network configuration for EKS Hybrid Nodes. Detailed below.\n" } }, "type": "object", "required": [ "remoteNodeNetworks" ], "language": { "nodejs": { "requiredOutputs": [ "remoteNodeNetworks", "remotePodNetworks" ] } } }, "aws:eks/ClusterRemoteNetworkConfigRemoteNodeNetworks:ClusterRemoteNetworkConfigRemoteNodeNetworks": { "properties": { "cidrs": { "type": "array", "items": { "type": "string" }, "description": "List of network CIDRs that can contain hybrid nodes.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:eks/ClusterRemoteNetworkConfigRemotePodNetworks:ClusterRemoteNetworkConfigRemotePodNetworks": { "properties": { "cidrs": { "type": "array", "items": { "type": "string" }, "description": "List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:eks/ClusterStorageConfig:ClusterStorageConfig": { "properties": { "blockStorage": { "$ref": "#/types/aws:eks/ClusterStorageConfigBlockStorage:ClusterStorageConfigBlockStorage", "description": "Configuration block with block storage configuration for the cluster. Detailed below.\n" } }, "type": "object" }, "aws:eks/ClusterStorageConfigBlockStorage:ClusterStorageConfigBlockStorage": { "properties": { "enabled": { "type": "boolean", "description": "Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete block storage volumes in your Amazon Web Services account.\n" } }, "type": "object" }, "aws:eks/ClusterUpgradePolicy:ClusterUpgradePolicy": { "properties": { "supportType": { "type": "string", "description": "Support type to use for the cluster. If the cluster is set to `EXTENDED`, it will enter extended support at the end of standard support. If the cluster is set to `STANDARD`, it will be automatically upgraded at the end of standard support. Valid values are `EXTENDED`, `STANDARD`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "supportType" ] } } }, "aws:eks/ClusterVpcConfig:ClusterVpcConfig": { "properties": { "clusterSecurityGroupId": { "type": "string", "description": "Cluster security group that is created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.\n" }, "endpointPrivateAccess": { "type": "boolean", "description": "Whether the Amazon EKS private API server endpoint is enabled. Default is `false`.\n" }, "endpointPublicAccess": { "type": "boolean", "description": "Whether the Amazon EKS public API server endpoint is enabled. Default is `true`.\n" }, "publicAccessCidrs": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint when enabled. EKS defaults this to a list with `0.0.0.0/0`. The provider will only perform drift detection of its value when present in a configuration.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs 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.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs. Must be in at least two different availability zones. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC associated with your cluster.\n" } }, "type": "object", "required": [ "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "clusterSecurityGroupId", "publicAccessCidrs", "subnetIds", "vpcId" ] } } }, "aws:eks/ClusterZonalShiftConfig:ClusterZonalShiftConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether zonal shift is enabled for the cluster.\n" } }, "type": "object" }, "aws:eks/FargateProfileSelector:FargateProfileSelector": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value map of Kubernetes labels for selection.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Kubernetes namespace for selection.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "namespace" ] }, "aws:eks/IdentityProviderConfigOidc:IdentityProviderConfigOidc": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OpenID Connect identity provider.\n", "willReplaceOnChanges": true }, "groupsClaim": { "type": "string", "description": "The JWT claim that the provider will use to return groups.\n", "willReplaceOnChanges": true }, "groupsPrefix": { "type": "string", "description": "A prefix that is prepended to group claims e.g., `oidc:`.\n", "willReplaceOnChanges": true }, "identityProviderConfigName": { "type": "string", "description": "The name of the identity provider config.\n", "willReplaceOnChanges": true }, "issuerUrl": { "type": "string", "description": "Issuer URL for the OpenID Connect identity provider.\n", "willReplaceOnChanges": true }, "requiredClaims": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The key value pairs that describe required claims in the identity token.\n", "willReplaceOnChanges": true }, "usernameClaim": { "type": "string", "description": "The JWT claim that the provider will use as the username.\n", "willReplaceOnChanges": true }, "usernamePrefix": { "type": "string", "description": "A prefix that is prepended to username claims.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "clientId", "identityProviderConfigName", "issuerUrl" ] }, "aws:eks/NodeGroupLaunchTemplate:NodeGroupLaunchTemplate": { "properties": { "id": { "type": "string", "description": "Identifier of the EC2 Launch Template. Conflicts with `name`.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the EC2 Launch Template. Conflicts with `id`.\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "EC2 Launch Template version number. While the API accepts values like `$Default` and `$Latest`, the API will convert the value to the associated version number (e.g., `1`) on read and the provider will show a difference on next plan. Using the `default_version` or `latest_version` attribute of the `aws.ec2.LaunchTemplate` resource or data source is recommended for this argument.\n" } }, "type": "object", "required": [ "version" ], "language": { "nodejs": { "requiredOutputs": [ "id", "name", "version" ] } } }, "aws:eks/NodeGroupNodeRepairConfig:NodeGroupNodeRepairConfig": { "properties": { "enabled": { "type": "boolean", "description": "Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default.\n" } }, "type": "object" }, "aws:eks/NodeGroupRemoteAccess:NodeGroupRemoteAccess": { "properties": { "ec2SshKey": { "type": "string", "description": "EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify `source_security_group_ids` when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes.\n", "willReplaceOnChanges": true }, "sourceSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify `ec2_ssh_key`, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:eks/NodeGroupResource:NodeGroupResource": { "properties": { "autoscalingGroups": { "type": "array", "items": { "$ref": "#/types/aws:eks/NodeGroupResourceAutoscalingGroup:NodeGroupResourceAutoscalingGroup" }, "description": "List of objects containing information about AutoScaling Groups.\n" }, "remoteAccessSecurityGroupId": { "type": "string", "description": "Identifier of the remote access EC2 Security Group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoscalingGroups", "remoteAccessSecurityGroupId" ] } } }, "aws:eks/NodeGroupResourceAutoscalingGroup:NodeGroupResourceAutoscalingGroup": { "properties": { "name": { "type": "string", "description": "Name of the AutoScaling Group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name" ] } } }, "aws:eks/NodeGroupScalingConfig:NodeGroupScalingConfig": { "properties": { "desiredSize": { "type": "integer", "description": "Desired number of worker nodes.\n" }, "maxSize": { "type": "integer", "description": "Maximum number of worker nodes.\n" }, "minSize": { "type": "integer", "description": "Minimum number of worker nodes.\n" } }, "type": "object", "required": [ "desiredSize", "maxSize", "minSize" ] }, "aws:eks/NodeGroupTaint:NodeGroupTaint": { "properties": { "effect": { "type": "string", "description": "The effect of the taint. Valid values: `NO_SCHEDULE`, `NO_EXECUTE`, `PREFER_NO_SCHEDULE`.\n" }, "key": { "type": "string", "description": "The key of the taint. Maximum length of 63.\n" }, "value": { "type": "string", "description": "The value of the taint. Maximum length of 63.\n" } }, "type": "object", "required": [ "effect", "key" ] }, "aws:eks/NodeGroupUpdateConfig:NodeGroupUpdateConfig": { "properties": { "maxUnavailable": { "type": "integer", "description": "Desired max number of unavailable worker nodes during node group update.\n" }, "maxUnavailablePercentage": { "type": "integer", "description": "Desired max percentage of unavailable worker nodes during node group update.\n" } }, "type": "object" }, "aws:eks/getAddonPodIdentityAssociation:getAddonPodIdentityAssociation": { "properties": { "roleArn": { "type": "string", "description": "ARN of the IAM role associated with the EKS add-on.\n" }, "serviceAccount": { "type": "string", "description": "Service account associated with the EKS add-on.\n" } }, "type": "object", "required": [ "roleArn", "serviceAccount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterAccessConfig:getClusterAccessConfig": { "properties": { "authenticationMode": { "type": "string", "description": "Values returned are `CONFIG_MAP`, `API` or `API_AND_CONFIG_MAP`\n" }, "bootstrapClusterCreatorAdminPermissions": { "type": "boolean", "description": "Default to `true`.\n" } }, "type": "object", "required": [ "authenticationMode", "bootstrapClusterCreatorAdminPermissions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterCertificateAuthority:getClusterCertificateAuthority": { "properties": { "data": { "type": "string", "description": "The base64 encoded certificate data required to communicate with your cluster. Add this to the `certificate-authority-data` section of the `kubeconfig` file for your cluster.\n" } }, "type": "object", "required": [ "data" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterComputeConfig:getClusterComputeConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether zonal shift is enabled.\n" }, "nodePools": { "type": "array", "items": { "type": "string" }, "description": "List of node pools for the EKS Auto Mode compute capability.\n" }, "nodeRoleArn": { "type": "string", "description": "The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.\n" } }, "type": "object", "required": [ "enabled", "nodePools", "nodeRoleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterIdentity:getClusterIdentity": { "properties": { "oidcs": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterIdentityOidc:getClusterIdentityOidc" }, "description": "Nested attribute containing [OpenID Connect](https://openid.net/connect/) identity provider information for the cluster.\n" } }, "type": "object", "required": [ "oidcs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterIdentityOidc:getClusterIdentityOidc": { "properties": { "issuer": { "type": "string", "description": "Issuer URL for the OpenID Connect identity provider.\n" } }, "type": "object", "required": [ "issuer" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterKubernetesNetworkConfig:getClusterKubernetesNetworkConfig": { "properties": { "elasticLoadBalancings": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterKubernetesNetworkConfigElasticLoadBalancing:getClusterKubernetesNetworkConfigElasticLoadBalancing" }, "description": "Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.\n" }, "ipFamily": { "type": "string", "description": "`ipv4` or `ipv6`.\n" }, "serviceIpv4Cidr": { "type": "string", "description": "The CIDR block to assign Kubernetes pod and service IP addresses from if `ipv4` was specified when the cluster was created.\n" }, "serviceIpv6Cidr": { "type": "string", "description": "The CIDR block to assign Kubernetes pod and service IP addresses from if `ipv6` was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.\n" } }, "type": "object", "required": [ "elasticLoadBalancings", "ipFamily", "serviceIpv4Cidr", "serviceIpv6Cidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterKubernetesNetworkConfigElasticLoadBalancing:getClusterKubernetesNetworkConfigElasticLoadBalancing": { "properties": { "enabled": { "type": "boolean", "description": "Whether zonal shift is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterOutpostConfig:getClusterOutpostConfig": { "properties": { "controlPlaneInstanceType": { "type": "string", "description": "The Amazon EC2 instance type for all Kubernetes control plane instances.\n" }, "controlPlanePlacements": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterOutpostConfigControlPlanePlacement:getClusterOutpostConfigControlPlanePlacement" }, "description": "An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.\n" }, "outpostArns": { "type": "array", "items": { "type": "string" }, "description": "List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.\n" } }, "type": "object", "required": [ "controlPlaneInstanceType", "controlPlanePlacements", "outpostArns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterOutpostConfigControlPlanePlacement:getClusterOutpostConfigControlPlanePlacement": { "properties": { "groupName": { "type": "string", "description": "The name of the placement group for the Kubernetes control plane instances.\n" } }, "type": "object", "required": [ "groupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterRemoteNetworkConfig:getClusterRemoteNetworkConfig": { "properties": { "remoteNodeNetworks": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterRemoteNetworkConfigRemoteNodeNetwork:getClusterRemoteNetworkConfigRemoteNodeNetwork" }, "description": "The networks that can contain hybrid nodes.\n" }, "remotePodNetworks": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterRemoteNetworkConfigRemotePodNetwork:getClusterRemoteNetworkConfigRemotePodNetwork" }, "description": "The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.\n" } }, "type": "object", "required": [ "remoteNodeNetworks", "remotePodNetworks" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterRemoteNetworkConfigRemoteNodeNetwork:getClusterRemoteNetworkConfigRemoteNodeNetwork": { "properties": { "cidrs": { "type": "array", "items": { "type": "string" }, "description": "List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.\n" } }, "type": "object", "required": [ "cidrs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterRemoteNetworkConfigRemotePodNetwork:getClusterRemoteNetworkConfigRemotePodNetwork": { "properties": { "cidrs": { "type": "array", "items": { "type": "string" }, "description": "List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.\n" } }, "type": "object", "required": [ "cidrs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterStorageConfig:getClusterStorageConfig": { "properties": { "blockStorages": { "type": "array", "items": { "$ref": "#/types/aws:eks/getClusterStorageConfigBlockStorage:getClusterStorageConfigBlockStorage" }, "description": "Contains block storage configuration for EKS Auto Mode enabled cluster.\n" } }, "type": "object", "required": [ "blockStorages" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterStorageConfigBlockStorage:getClusterStorageConfigBlockStorage": { "properties": { "enabled": { "type": "boolean", "description": "Whether zonal shift is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterUpgradePolicy:getClusterUpgradePolicy": { "properties": { "supportType": { "type": "string", "description": "Support type to use for the cluster.\n" } }, "type": "object", "required": [ "supportType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterVersionsClusterVersion:getClusterVersionsClusterVersion": { "properties": { "clusterType": { "type": "string", "description": "Type of clusters to filter by.\nCurrently, the only valid value is `eks`.\n" }, "clusterVersion": { "type": "string", "description": "Kubernetes version supported by EKS.\n" }, "defaultPlatformVersion": { "type": "string", "description": "Default eks platform version for the cluster version.\n" }, "defaultVersion": { "type": "boolean", "description": "Default Kubernetes version for the cluster version.\n" }, "endOfExtendedSupportDate": { "type": "string", "description": "End of extended support date for the cluster version.\n" }, "endOfStandardSupportDate": { "type": "string", "description": "End of standard support date for the cluster version.\n" }, "kubernetesPatchVersion": { "type": "string", "description": "Kubernetes patch version for the cluster version.\n" }, "releaseDate": { "type": "string", "description": "Release date of the cluster version.\n" }, "versionStatus": { "type": "string", "description": "Status of the EKS cluster versions to list.\nValid values are `STANDARD_SUPPORT` or `UNSUPPORTED` or `EXTENDED_SUPPORT`.\n" } }, "type": "object", "required": [ "clusterType", "clusterVersion", "defaultPlatformVersion", "defaultVersion", "endOfExtendedSupportDate", "endOfStandardSupportDate", "kubernetesPatchVersion", "releaseDate", "versionStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterVpcConfig:getClusterVpcConfig": { "properties": { "clusterSecurityGroupId": { "type": "string", "description": "The cluster security group that was created by Amazon EKS for the cluster.\n" }, "endpointPrivateAccess": { "type": "boolean", "description": "Indicates whether or not the Amazon EKS private API server endpoint is enabled.\n" }, "endpointPublicAccess": { "type": "boolean", "description": "Indicates whether or not the Amazon EKS public API server endpoint is enabled.\n" }, "publicAccessCidrs": { "type": "array", "items": { "type": "string" }, "description": "List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs\n" }, "vpcId": { "type": "string", "description": "The VPC associated with your cluster.\n" } }, "type": "object", "required": [ "clusterSecurityGroupId", "endpointPrivateAccess", "endpointPublicAccess", "publicAccessCidrs", "securityGroupIds", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getClusterZonalShiftConfig:getClusterZonalShiftConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether zonal shift is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupLaunchTemplate:getNodeGroupLaunchTemplate": { "properties": { "id": { "type": "string", "description": "The ID of the launch template.\n" }, "name": { "type": "string", "description": "Name of the AutoScaling Group.\n" }, "version": { "type": "string", "description": "Kubernetes version.\n" } }, "type": "object", "required": [ "id", "name", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupRemoteAccess:getNodeGroupRemoteAccess": { "properties": { "ec2SshKey": { "type": "string", "description": "EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.\n" }, "sourceSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.\n" } }, "type": "object", "required": [ "ec2SshKey", "sourceSecurityGroupIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupResource:getNodeGroupResource": { "properties": { "autoscalingGroups": { "type": "array", "items": { "$ref": "#/types/aws:eks/getNodeGroupResourceAutoscalingGroup:getNodeGroupResourceAutoscalingGroup" }, "description": "List of objects containing information about AutoScaling Groups.\n" }, "remoteAccessSecurityGroupId": { "type": "string", "description": "Identifier of the remote access EC2 Security Group.\n" } }, "type": "object", "required": [ "autoscalingGroups", "remoteAccessSecurityGroupId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupResourceAutoscalingGroup:getNodeGroupResourceAutoscalingGroup": { "properties": { "name": { "type": "string", "description": "Name of the AutoScaling Group.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupScalingConfig:getNodeGroupScalingConfig": { "properties": { "desiredSize": { "type": "integer", "description": "Desired number of worker nodes.\n" }, "maxSize": { "type": "integer", "description": "Maximum number of worker nodes.\n" }, "minSize": { "type": "integer", "description": "Minimum number of worker nodes.\n" } }, "type": "object", "required": [ "desiredSize", "maxSize", "minSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:eks/getNodeGroupTaint:getNodeGroupTaint": { "properties": { "effect": { "type": "string", "description": "The effect of the taint.\n" }, "key": { "type": "string", "description": "The key of the taint.\n" }, "value": { "type": "string", "description": "The value of the taint.\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/ClusterCacheNode:ClusterCacheNode": { "properties": { "address": { "type": "string" }, "availabilityZone": { "type": "string", "description": "Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use `preferred_availability_zones` instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.\n" }, "id": { "type": "string" }, "outpostArn": { "type": "string" }, "port": { "type": "integer", "description": "The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replication_group_id`. Changing this value will re-create the resource.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "availabilityZone", "id", "outpostArn", "port" ] } } }, "aws:elasticache/ClusterLogDeliveryConfiguration:ClusterLogDeliveryConfiguration": { "properties": { "destination": { "type": "string", "description": "Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.\n" }, "destinationType": { "type": "string", "description": "For CloudWatch Logs use `cloudwatch-logs` or for Kinesis Data Firehose use `kinesis-firehose`.\n" }, "logFormat": { "type": "string", "description": "Valid values are `json` or `text`\n" }, "logType": { "type": "string", "description": "Valid values are `slow-log` or `engine-log`. Max 1 of each.\n" } }, "type": "object", "required": [ "destination", "destinationType", "logFormat", "logType" ] }, "aws:elasticache/GlobalReplicationGroupGlobalNodeGroup:GlobalReplicationGroupGlobalNodeGroup": { "properties": { "globalNodeGroupId": { "type": "string", "description": "The ID of the global node group.\n" }, "slots": { "type": "string", "description": "The keyspace for this node group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "globalNodeGroupId", "slots" ] } } }, "aws:elasticache/ParameterGroupParameter:ParameterGroupParameter": { "properties": { "name": { "type": "string", "description": "The name of the ElastiCache parameter.\n" }, "value": { "type": "string", "description": "The value of the ElastiCache parameter.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:elasticache/ReplicationGroupLogDeliveryConfiguration:ReplicationGroupLogDeliveryConfiguration": { "properties": { "destination": { "type": "string", "description": "Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource.\n" }, "destinationType": { "type": "string", "description": "For CloudWatch Logs use `cloudwatch-logs` or for Kinesis Data Firehose use `kinesis-firehose`.\n" }, "logFormat": { "type": "string", "description": "Valid values are `json` or `text`\n" }, "logType": { "type": "string", "description": "Valid values are `slow-log` or `engine-log`. Max 1 of each.\n" } }, "type": "object", "required": [ "destination", "destinationType", "logFormat", "logType" ] }, "aws:elasticache/ReservedCacheNodeRecurringCharge:ReservedCacheNodeRecurringCharge": { "properties": { "recurringChargeAmount": { "type": "number" }, "recurringChargeFrequency": { "type": "string" } }, "type": "object", "required": [ "recurringChargeAmount", "recurringChargeFrequency" ] }, "aws:elasticache/ReservedCacheNodeTimeouts:ReservedCacheNodeTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:elasticache/ServerlessCacheCacheUsageLimits:ServerlessCacheCacheUsageLimits": { "properties": { "dataStorage": { "$ref": "#/types/aws:elasticache/ServerlessCacheCacheUsageLimitsDataStorage:ServerlessCacheCacheUsageLimitsDataStorage", "description": "The maximum data storage limit in the cache, expressed in Gigabytes. See `data_storage` Block for details.\n" }, "ecpuPerSeconds": { "type": "array", "items": { "$ref": "#/types/aws:elasticache/ServerlessCacheCacheUsageLimitsEcpuPerSecond:ServerlessCacheCacheUsageLimitsEcpuPerSecond" }, "description": "The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See `ecpu_per_second` Block for details.\n" } }, "type": "object" }, "aws:elasticache/ServerlessCacheCacheUsageLimitsDataStorage:ServerlessCacheCacheUsageLimitsDataStorage": { "properties": { "maximum": { "type": "integer", "description": "The upper limit for data storage the cache is set to use. Must be between 1 and 5,000.\n" }, "minimum": { "type": "integer", "description": "The lower limit for data storage the cache is set to use. Must be between 1 and 5,000.\n" }, "unit": { "type": "string", "description": "The unit that the storage is measured in, in GB.\n" } }, "type": "object", "required": [ "unit" ] }, "aws:elasticache/ServerlessCacheCacheUsageLimitsEcpuPerSecond:ServerlessCacheCacheUsageLimitsEcpuPerSecond": { "properties": { "maximum": { "type": "integer", "description": "The maximum number of ECPUs the cache can consume per second. Must be between 1,000 and 15,000,000.\n" }, "minimum": { "type": "integer", "description": "The minimum number of ECPUs the cache can consume per second. Must be between 1,000 and 15,000,000.\n" } }, "type": "object" }, "aws:elasticache/ServerlessCacheEndpoint:ServerlessCacheEndpoint": { "properties": { "address": { "type": "string", "description": "The DNS hostname of the cache node.\n" }, "port": { "type": "integer", "description": "The port number that the cache engine is listening on. Set as integer.\n" } }, "type": "object", "required": [ "address", "port" ] }, "aws:elasticache/ServerlessCacheReaderEndpoint:ServerlessCacheReaderEndpoint": { "properties": { "address": { "type": "string", "description": "The DNS hostname of the cache node.\n" }, "port": { "type": "integer", "description": "The port number that the cache engine is listening on. Set as integer.\n" } }, "type": "object", "required": [ "address", "port" ] }, "aws:elasticache/ServerlessCacheTimeouts:ServerlessCacheTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:elasticache/UserAuthenticationMode:UserAuthenticationMode": { "properties": { "passwordCount": { "type": "integer" }, "passwords": { "type": "array", "items": { "type": "string" }, "description": "Specifies the passwords to use for authentication if `type` is set to `password`.\n", "secret": true }, "type": { "type": "string", "description": "Specifies the authentication type. Possible options are: `password`, `no-password-required` or `iam`.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "passwordCount", "type" ] } } }, "aws:elasticache/getClusterCacheNode:getClusterCacheNode": { "properties": { "address": { "type": "string" }, "availabilityZone": { "type": "string", "description": "Availability Zone for the cache cluster.\n" }, "id": { "type": "string" }, "outpostArn": { "type": "string" }, "port": { "type": "integer", "description": "The port number on which each of the cache nodes will\naccept connections.\n" } }, "type": "object", "required": [ "address", "availabilityZone", "id", "outpostArn", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getClusterLogDeliveryConfiguration:getClusterLogDeliveryConfiguration": { "properties": { "destination": { "type": "string" }, "destinationType": { "type": "string" }, "logFormat": { "type": "string" }, "logType": { "type": "string" } }, "type": "object", "required": [ "destination", "destinationType", "logFormat", "logType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getReplicationGroupLogDeliveryConfiguration:getReplicationGroupLogDeliveryConfiguration": { "properties": { "destination": { "type": "string" }, "destinationType": { "type": "string" }, "logFormat": { "type": "string" }, "logType": { "type": "string" } }, "type": "object", "required": [ "destination", "destinationType", "logFormat", "logType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getServerlessCacheCacheUsageLimits:getServerlessCacheCacheUsageLimits": { "properties": { "dataStorage": { "$ref": "#/types/aws:elasticache/getServerlessCacheCacheUsageLimitsDataStorage:getServerlessCacheCacheUsageLimitsDataStorage", "description": "The maximum data storage limit in the cache, expressed in Gigabytes. See `data_storage` Block for details.\n" }, "ecpuPerSecond": { "$ref": "#/types/aws:elasticache/getServerlessCacheCacheUsageLimitsEcpuPerSecond:getServerlessCacheCacheUsageLimitsEcpuPerSecond", "description": "The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See `ecpu_per_second` Block for details.\n" } }, "type": "object", "required": [ "dataStorage", "ecpuPerSecond" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getServerlessCacheCacheUsageLimitsDataStorage:getServerlessCacheCacheUsageLimitsDataStorage": { "properties": { "maximum": { "type": "integer", "description": "The maximum number of ECPUs the cache can consume per second.\n" }, "minimum": { "type": "integer", "description": "The minimum number of ECPUs the cache can consume per second.\n" }, "unit": { "type": "string", "description": "The unit that the storage is measured in.\n" } }, "type": "object", "required": [ "maximum", "minimum", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getServerlessCacheCacheUsageLimitsEcpuPerSecond:getServerlessCacheCacheUsageLimitsEcpuPerSecond": { "properties": { "maximum": { "type": "integer", "description": "The maximum number of ECPUs the cache can consume per second.\n" }, "minimum": { "type": "integer", "description": "The minimum number of ECPUs the cache can consume per second.\n" } }, "type": "object", "required": [ "maximum", "minimum" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getServerlessCacheEndpoint:getServerlessCacheEndpoint": { "properties": { "address": { "type": "string", "description": "The DNS hostname of the cache node.\n" }, "port": { "type": "integer", "description": "The port number that the cache engine is listening on. Set as integer.\n" } }, "type": "object", "required": [ "address", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getServerlessCacheReaderEndpoint:getServerlessCacheReaderEndpoint": { "properties": { "address": { "type": "string", "description": "The DNS hostname of the cache node.\n" }, "port": { "type": "integer", "description": "The port number that the cache engine is listening on. Set as integer.\n" } }, "type": "object", "required": [ "address", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticache/getUserAuthenticationMode:getUserAuthenticationMode": { "properties": { "passwordCount": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "aws:elasticbeanstalk/ApplicationAppversionLifecycle:ApplicationAppversionLifecycle": { "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Set to `true` to delete a version's source bundle from S3 when the application version is deleted.\n" }, "maxAgeInDays": { "type": "integer", "description": "The number of days to retain an application version ('max_age_in_days' and 'max_count' cannot be enabled simultaneously.).\n" }, "maxCount": { "type": "integer", "description": "The maximum number of application versions to retain ('max_age_in_days' and 'max_count' cannot be enabled simultaneously.).\n" }, "serviceRole": { "type": "string", "description": "The ARN of an IAM service role under which the application version is deleted. Elastic Beanstalk must have permission to assume this role.\n" } }, "type": "object", "required": [ "serviceRole" ] }, "aws:elasticbeanstalk/ConfigurationTemplateSetting:ConfigurationTemplateSetting": { "properties": { "name": { "type": "string", "description": "A unique name for this Template.\n" }, "namespace": { "type": "string" }, "resource": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "name", "namespace", "value" ] }, "aws:elasticbeanstalk/EnvironmentAllSetting:EnvironmentAllSetting": { "properties": { "name": { "type": "string", "description": "A unique name for this Environment. This name is used\nin the application URL\n" }, "namespace": { "type": "string" }, "resource": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "name", "namespace", "value" ] }, "aws:elasticbeanstalk/EnvironmentSetting:EnvironmentSetting": { "properties": { "name": { "type": "string", "description": "A unique name for this Environment. This name is used\nin the application URL\n" }, "namespace": { "type": "string" }, "resource": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "name", "namespace", "value" ] }, "aws:elasticbeanstalk/getApplicationAppversionLifecycle:getApplicationAppversionLifecycle": { "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Specifies whether delete a version's source bundle from S3 when the application version is deleted.\n" }, "maxAgeInDays": { "type": "integer", "description": "Number of days to retain an application version.\n" }, "maxCount": { "type": "integer", "description": "Maximum number of application versions to retain.\n" }, "serviceRole": { "type": "string", "description": "ARN of an IAM service role under which the application version is deleted. Elastic Beanstalk must have permission to assume this role.\n" } }, "type": "object", "required": [ "deleteSourceFromS3", "maxAgeInDays", "maxCount", "serviceRole" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/DomainAdvancedSecurityOptions:DomainAdvancedSecurityOptions": { "properties": { "enabled": { "type": "boolean", "description": "Whether advanced security is enabled.\n", "willReplaceOnChanges": true }, "internalUserDatabaseEnabled": { "type": "boolean", "description": "Whether the internal user database is enabled. If not set, defaults to `false` by the AWS API.\n" }, "masterUserOptions": { "$ref": "#/types/aws:elasticsearch/DomainAdvancedSecurityOptionsMasterUserOptions:DomainAdvancedSecurityOptionsMasterUserOptions", "description": "Configuration block for the main user. Detailed below.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:elasticsearch/DomainAdvancedSecurityOptionsMasterUserOptions:DomainAdvancedSecurityOptionsMasterUserOptions": { "properties": { "masterUserArn": { "type": "string", "description": "ARN for the main user. Only specify if `internal_user_database_enabled` is not set or set to `false`.\n" }, "masterUserName": { "type": "string", "description": "Main user's username, which is stored in the Amazon Elasticsearch Service domain's internal database. Only specify if `internal_user_database_enabled` is set to `true`.\n" }, "masterUserPassword": { "type": "string", "description": "Main user's password, which is stored in the Amazon Elasticsearch Service domain's internal database. Only specify if `internal_user_database_enabled` is set to `true`.\n", "secret": true } }, "type": "object" }, "aws:elasticsearch/DomainAutoTuneOptions:DomainAutoTuneOptions": { "properties": { "desiredState": { "type": "string", "description": "The Auto-Tune desired state for the domain. Valid values: `ENABLED` or `DISABLED`.\n" }, "maintenanceSchedules": { "type": "array", "items": { "$ref": "#/types/aws:elasticsearch/DomainAutoTuneOptionsMaintenanceSchedule:DomainAutoTuneOptionsMaintenanceSchedule" }, "description": "Configuration block for Auto-Tune maintenance windows. Can be specified multiple times for each maintenance window. Detailed below.\n" }, "rollbackOnDisable": { "type": "string", "description": "Whether to roll back to default Auto-Tune settings when disabling Auto-Tune. Valid values: `DEFAULT_ROLLBACK` or `NO_ROLLBACK`.\n" } }, "type": "object", "required": [ "desiredState" ], "language": { "nodejs": { "requiredOutputs": [ "desiredState", "maintenanceSchedules", "rollbackOnDisable" ] } } }, "aws:elasticsearch/DomainAutoTuneOptionsMaintenanceSchedule:DomainAutoTuneOptionsMaintenanceSchedule": { "properties": { "cronExpressionForRecurrence": { "type": "string", "description": "A cron expression specifying the recurrence pattern for an Auto-Tune maintenance schedule.\n" }, "duration": { "$ref": "#/types/aws:elasticsearch/DomainAutoTuneOptionsMaintenanceScheduleDuration:DomainAutoTuneOptionsMaintenanceScheduleDuration", "description": "Configuration block for the duration of the Auto-Tune maintenance window. Detailed below.\n" }, "startAt": { "type": "string", "description": "Date and time at which to start the Auto-Tune maintenance schedule in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" } }, "type": "object", "required": [ "cronExpressionForRecurrence", "duration", "startAt" ] }, "aws:elasticsearch/DomainAutoTuneOptionsMaintenanceScheduleDuration:DomainAutoTuneOptionsMaintenanceScheduleDuration": { "properties": { "unit": { "type": "string", "description": "The unit of time specifying the duration of an Auto-Tune maintenance window. Valid values: `HOURS`.\n" }, "value": { "type": "integer", "description": "An integer specifying the value of the duration of an Auto-Tune maintenance window.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:elasticsearch/DomainClusterConfig:DomainClusterConfig": { "properties": { "coldStorageOptions": { "$ref": "#/types/aws:elasticsearch/DomainClusterConfigColdStorageOptions:DomainClusterConfigColdStorageOptions", "description": "Configuration block containing cold storage configuration. Detailed below.\n" }, "dedicatedMasterCount": { "type": "integer", "description": "Number of dedicated main nodes in the cluster.\n" }, "dedicatedMasterEnabled": { "type": "boolean", "description": "Whether dedicated main nodes are enabled for the cluster.\n" }, "dedicatedMasterType": { "type": "string", "description": "Instance type of the dedicated main nodes in the cluster.\n" }, "instanceCount": { "type": "integer", "description": "Number of instances in the cluster.\n" }, "instanceType": { "type": "string", "description": "Instance type of data nodes in the cluster.\n" }, "warmCount": { "type": "integer", "description": "Number of warm nodes in the cluster. Valid values are between `2` and `150`. `warm_count` can be only and must be set when `warm_enabled` is set to `true`.\n" }, "warmEnabled": { "type": "boolean", "description": "Whether to enable warm storage.\n" }, "warmType": { "type": "string", "description": "Instance type for the Elasticsearch cluster's warm nodes. Valid values are `ultrawarm1.medium.elasticsearch`, `ultrawarm1.large.elasticsearch` and `ultrawarm1.xlarge.elasticsearch`. `warm_type` can be only and must be set when `warm_enabled` is set to `true`.\n" }, "zoneAwarenessConfig": { "$ref": "#/types/aws:elasticsearch/DomainClusterConfigZoneAwarenessConfig:DomainClusterConfigZoneAwarenessConfig", "description": "Configuration block containing zone awareness settings. Detailed below.\n" }, "zoneAwarenessEnabled": { "type": "boolean", "description": "Whether zone awareness is enabled, set to `true` for multi-az deployment. To enable awareness with three Availability Zones, the `availability_zone_count` within the `zone_awareness_config` must be set to `3`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "coldStorageOptions" ] } } }, "aws:elasticsearch/DomainClusterConfigColdStorageOptions:DomainClusterConfigColdStorageOptions": { "properties": { "enabled": { "type": "boolean", "description": "Boolean to enable cold storage for an Elasticsearch domain. Defaults to `false`. Master and ultrawarm nodes must be enabled for cold storage.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:elasticsearch/DomainClusterConfigZoneAwarenessConfig:DomainClusterConfigZoneAwarenessConfig": { "properties": { "availabilityZoneCount": { "type": "integer", "description": "Number of Availability Zones for the domain to use with `zone_awareness_enabled`. Defaults to `2`. Valid values: `2` or `3`.\n" } }, "type": "object" }, "aws:elasticsearch/DomainCognitoOptions:DomainCognitoOptions": { "properties": { "enabled": { "type": "boolean", "description": "Whether Amazon Cognito authentication with Kibana is enabled or not.\n" }, "identityPoolId": { "type": "string", "description": "ID of the Cognito Identity Pool to use.\n" }, "roleArn": { "type": "string", "description": "ARN of the IAM role that has the AmazonESCognitoAccess policy attached.\n" }, "userPoolId": { "type": "string", "description": "ID of the Cognito User Pool to use.\n" } }, "type": "object", "required": [ "identityPoolId", "roleArn", "userPoolId" ] }, "aws:elasticsearch/DomainDomainEndpointOptions:DomainDomainEndpointOptions": { "properties": { "customEndpoint": { "type": "string", "description": "Fully qualified domain for your custom endpoint.\n" }, "customEndpointCertificateArn": { "type": "string", "description": "ACM certificate ARN for your custom endpoint.\n" }, "customEndpointEnabled": { "type": "boolean", "description": "Whether to enable custom endpoint for the Elasticsearch domain.\n" }, "enforceHttps": { "type": "boolean", "description": "Whether or not to require HTTPS. Defaults to `true`.\n" }, "tlsSecurityPolicy": { "type": "string", "description": "Name of the TLS security policy that needs to be applied to the HTTPS endpoint. Valid values: `Policy-Min-TLS-1-0-2019-07`, `Policy-Min-TLS-1-2-2019-07`, and `Policy-Min-TLS-1-2-PFS-2023-10`. Pulumi will only perform drift detection if a configuration value is provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "tlsSecurityPolicy" ] } } }, "aws:elasticsearch/DomainEbsOptions:DomainEbsOptions": { "properties": { "ebsEnabled": { "type": "boolean", "description": "Whether EBS volumes are attached to data nodes in the domain.\n" }, "iops": { "type": "integer", "description": "Baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the GP3 and Provisioned IOPS EBS volume types.\n" }, "throughput": { "type": "integer", "description": "Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.\n" }, "volumeSize": { "type": "integer", "description": "Size of EBS volumes attached to data nodes (in GiB).\n" }, "volumeType": { "type": "string", "description": "Type of EBS volumes attached to data nodes.\n" } }, "type": "object", "required": [ "ebsEnabled" ], "language": { "nodejs": { "requiredOutputs": [ "ebsEnabled", "iops", "throughput", "volumeType" ] } } }, "aws:elasticsearch/DomainEncryptAtRest:DomainEncryptAtRest": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable encryption at rest. If the `encrypt_at_rest` block is not provided then this defaults to `false`. Enabling encryption on new domains requires `elasticsearch_version` 5.1 or greater.\n" }, "kmsKeyId": { "type": "string", "description": "KMS key ARN to encrypt the Elasticsearch domain with. If not specified then it defaults to using the `aws/es` service KMS key. Note that KMS will accept a KMS key ID but will return the key ARN. To prevent the provider detecting unwanted changes, use the key ARN instead.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "enabled", "kmsKeyId" ] } } }, "aws:elasticsearch/DomainLogPublishingOption:DomainLogPublishingOption": { "properties": { "cloudwatchLogGroupArn": { "type": "string", "description": "ARN of the Cloudwatch log group to which log needs to be published.\n" }, "enabled": { "type": "boolean", "description": "Whether given log publishing option is enabled or not.\n" }, "logType": { "type": "string", "description": "Type of Elasticsearch log. Valid values: `INDEX_SLOW_LOGS`, `SEARCH_SLOW_LOGS`, `ES_APPLICATION_LOGS`, `AUDIT_LOGS`.\n" } }, "type": "object", "required": [ "cloudwatchLogGroupArn", "logType" ] }, "aws:elasticsearch/DomainNodeToNodeEncryption:DomainNodeToNodeEncryption": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable node-to-node encryption. If the `node_to_node_encryption` block is not provided then this defaults to `false`. Enabling node-to-node encryption of a new domain requires an `elasticsearch_version` of `6.0` or greater.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:elasticsearch/DomainSamlOptionsSamlOptions:DomainSamlOptionsSamlOptions": { "properties": { "enabled": { "type": "boolean", "description": "Whether SAML authentication is enabled.\n" }, "idp": { "$ref": "#/types/aws:elasticsearch/DomainSamlOptionsSamlOptionsIdp:DomainSamlOptionsSamlOptionsIdp", "description": "Information from your identity provider.\n" }, "masterBackendRole": { "type": "string", "description": "This backend role from the SAML IdP receives full permissions to the cluster, equivalent to a new master user.\n" }, "masterUserName": { "type": "string", "description": "This username from the SAML IdP receives full permissions to the cluster, equivalent to a new master user.\n", "secret": true }, "rolesKey": { "type": "string", "description": "Element of the SAML assertion to use for backend roles. Default is roles.\n" }, "sessionTimeoutMinutes": { "type": "integer", "description": "Duration of a session in minutes after a user logs in. Default is 60. Maximum value is 1,440.\n" }, "subjectKey": { "type": "string", "description": "Custom SAML attribute to use for user names. Default is an empty string - `\"\"`. This will cause Elasticsearch to use the `NameID` element of the `Subject`, which is the default location for name identifiers in the SAML specification.\n" } }, "type": "object" }, "aws:elasticsearch/DomainSamlOptionsSamlOptionsIdp:DomainSamlOptionsSamlOptionsIdp": { "properties": { "entityId": { "type": "string", "description": "The unique Entity ID of the application in SAML Identity Provider.\n" }, "metadataContent": { "type": "string", "description": "The Metadata of the SAML application in xml format.\n" } }, "type": "object", "required": [ "entityId", "metadataContent" ] }, "aws:elasticsearch/DomainSnapshotOptions:DomainSnapshotOptions": { "properties": { "automatedSnapshotStartHour": { "type": "integer", "description": "Hour during which the service takes an automated daily snapshot of the indices in the domain.\n" } }, "type": "object", "required": [ "automatedSnapshotStartHour" ] }, "aws:elasticsearch/DomainVpcOptions:DomainVpcOptions": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "If the domain was created inside a VPC, the names of the availability zones the configured `subnet_ids` were created inside.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC Security Group IDs to be applied to the Elasticsearch domain endpoints. If omitted, the default Security Group for the VPC will be used.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC Subnet IDs for the Elasticsearch domain endpoints to be created in.\n" }, "vpcId": { "type": "string", "description": "If the domain was created inside a VPC, the ID of the VPC.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityZones", "vpcId" ] } } }, "aws:elasticsearch/VpcEndpointVpcOptions:VpcEndpointVpcOptions": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" } }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, elasticsearch Service uses the default security group for the VPC.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.\n" }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityZones", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "aws:elasticsearch/getDomainAdvancedSecurityOption:getDomainAdvancedSecurityOption": { "properties": { "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" }, "internalUserDatabaseEnabled": { "type": "boolean", "description": "Whether the internal user database is enabled.\n" } }, "type": "object", "required": [ "enabled", "internalUserDatabaseEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainAutoTuneOption:getDomainAutoTuneOption": { "properties": { "desiredState": { "type": "string", "description": "The Auto-Tune desired state for the domain.\n" }, "maintenanceSchedules": { "type": "array", "items": { "$ref": "#/types/aws:elasticsearch/getDomainAutoTuneOptionMaintenanceSchedule:getDomainAutoTuneOptionMaintenanceSchedule" }, "description": "A list of the nested configurations for the Auto-Tune maintenance windows of the domain.\n" }, "rollbackOnDisable": { "type": "string", "description": "Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.\n" } }, "type": "object", "required": [ "desiredState", "maintenanceSchedules", "rollbackOnDisable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainAutoTuneOptionMaintenanceSchedule:getDomainAutoTuneOptionMaintenanceSchedule": { "properties": { "cronExpressionForRecurrence": { "type": "string", "description": "Cron expression for an Auto-Tune maintenance schedule.\n" }, "durations": { "type": "array", "items": { "$ref": "#/types/aws:elasticsearch/getDomainAutoTuneOptionMaintenanceScheduleDuration:getDomainAutoTuneOptionMaintenanceScheduleDuration" }, "description": "Configuration block for the duration of the Auto-Tune maintenance window.\n" }, "startAt": { "type": "string", "description": "Date and time at which the Auto-Tune maintenance schedule starts in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" } }, "type": "object", "required": [ "cronExpressionForRecurrence", "durations", "startAt" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainAutoTuneOptionMaintenanceScheduleDuration:getDomainAutoTuneOptionMaintenanceScheduleDuration": { "properties": { "unit": { "type": "string", "description": "Unit of time.\n" }, "value": { "type": "integer", "description": "Duration of an Auto-Tune maintenance window.\n" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainClusterConfig:getDomainClusterConfig": { "properties": { "coldStorageOptions": { "type": "array", "items": { "$ref": "#/types/aws:elasticsearch/getDomainClusterConfigColdStorageOption:getDomainClusterConfigColdStorageOption" }, "description": "Configuration block containing cold storage configuration.\n" }, "dedicatedMasterCount": { "type": "integer", "description": "Number of dedicated master nodes in the cluster.\n" }, "dedicatedMasterEnabled": { "type": "boolean", "description": "Indicates whether dedicated master nodes are enabled for the cluster.\n" }, "dedicatedMasterType": { "type": "string", "description": "Instance type of the dedicated master nodes in the cluster.\n" }, "instanceCount": { "type": "integer", "description": "Number of instances in the cluster.\n" }, "instanceType": { "type": "string", "description": "Instance type of data nodes in the cluster.\n" }, "warmCount": { "type": "integer", "description": "The number of warm nodes in the cluster.\n" }, "warmEnabled": { "type": "boolean", "description": "Warm storage is enabled.\n" }, "warmType": { "type": "string", "description": "The instance type for the Elasticsearch cluster's warm nodes.\n" }, "zoneAwarenessConfigs": { "type": "array", "items": { "$ref": "#/types/aws:elasticsearch/getDomainClusterConfigZoneAwarenessConfig:getDomainClusterConfigZoneAwarenessConfig" }, "description": "Configuration block containing zone awareness settings.\n" }, "zoneAwarenessEnabled": { "type": "boolean", "description": "Indicates whether zone awareness is enabled.\n" } }, "type": "object", "required": [ "coldStorageOptions", "dedicatedMasterCount", "dedicatedMasterEnabled", "dedicatedMasterType", "instanceCount", "instanceType", "warmCount", "warmEnabled", "warmType", "zoneAwarenessConfigs", "zoneAwarenessEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainClusterConfigColdStorageOption:getDomainClusterConfigColdStorageOption": { "properties": { "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainClusterConfigZoneAwarenessConfig:getDomainClusterConfigZoneAwarenessConfig": { "properties": { "availabilityZoneCount": { "type": "integer", "description": "Number of availability zones used.\n" } }, "type": "object", "required": [ "availabilityZoneCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainCognitoOption:getDomainCognitoOption": { "properties": { "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" }, "identityPoolId": { "type": "string", "description": "The Cognito Identity pool used by the domain.\n" }, "roleArn": { "type": "string", "description": "The IAM Role with the AmazonESCognitoAccess policy attached.\n" }, "userPoolId": { "type": "string", "description": "The Cognito User pool used by the domain.\n" } }, "type": "object", "required": [ "enabled", "identityPoolId", "roleArn", "userPoolId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainEbsOption:getDomainEbsOption": { "properties": { "ebsEnabled": { "type": "boolean", "description": "Whether EBS volumes are attached to data nodes in the domain.\n" }, "iops": { "type": "integer", "description": "The baseline input/output (I/O) performance of EBS volumes attached to data nodes.\n" }, "throughput": { "type": "integer", "description": "The throughput (in MiB/s) of the EBS volumes attached to data nodes.\n" }, "volumeSize": { "type": "integer", "description": "The size of EBS volumes attached to data nodes (in GB).\n" }, "volumeType": { "type": "string", "description": "The type of EBS volumes attached to data nodes.\n" } }, "type": "object", "required": [ "ebsEnabled", "iops", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainEncryptionAtRest:getDomainEncryptionAtRest": { "properties": { "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" }, "kmsKeyId": { "type": "string", "description": "The KMS key id used to encrypt data at rest.\n" } }, "type": "object", "required": [ "enabled", "kmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainLogPublishingOption:getDomainLogPublishingOption": { "properties": { "cloudwatchLogGroupArn": { "type": "string", "description": "The CloudWatch Log Group where the logs are published.\n" }, "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" }, "logType": { "type": "string", "description": "The type of Elasticsearch log being published.\n" } }, "type": "object", "required": [ "cloudwatchLogGroupArn", "enabled", "logType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainNodeToNodeEncryption:getDomainNodeToNodeEncryption": { "properties": { "enabled": { "type": "boolean", "description": "Whether node to node encryption is enabled.\n" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainSnapshotOption:getDomainSnapshotOption": { "properties": { "automatedSnapshotStartHour": { "type": "integer", "description": "Hour during which the service takes an automated daily snapshot of the indices in the domain.\n" } }, "type": "object", "required": [ "automatedSnapshotStartHour" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elasticsearch/getDomainVpcOption:getDomainVpcOption": { "properties": { "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "The availability zones used by the domain.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The security groups used by the domain.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The subnets used by the domain.\n" }, "vpcId": { "type": "string", "description": "The VPC used by the domain.\n" } }, "type": "object", "required": [ "availabilityZones", "securityGroupIds", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elastictranscoder/PipelineContentConfig:PipelineContentConfig": { "properties": { "bucket": { "type": "string", "description": "The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.\n" }, "storageClass": { "type": "string", "description": "The Amazon S3 storage class, `Standard` or `ReducedRedundancy`, that you want Elastic Transcoder to assign to the files and playlists that it stores in your Amazon S3 bucket.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket" ] } } }, "aws:elastictranscoder/PipelineContentConfigPermission:PipelineContentConfigPermission": { "properties": { "accesses": { "type": "array", "items": { "type": "string" }, "description": "The permission that you want to give to the AWS user that you specified in `content_config_permissions.grantee`. Valid values are `Read`, `ReadAcp`, `WriteAcp` or `FullControl`.\n" }, "grantee": { "type": "string", "description": "The AWS user or group that you want to have access to transcoded files and playlists.\n" }, "granteeType": { "type": "string", "description": "Specify the type of value that appears in the `content_config_permissions.grantee` object. Valid values are `Canonical`, `Email` or `Group`.\n" } }, "type": "object" }, "aws:elastictranscoder/PipelineNotifications:PipelineNotifications": { "properties": { "completed": { "type": "string", "description": "The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline.\n" }, "error": { "type": "string", "description": "The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline.\n" }, "progressing": { "type": "string", "description": "The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline.\n" }, "warning": { "type": "string", "description": "The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline.\n\nThe `thumbnail_config` object specifies information about the Amazon S3 bucket in\nwhich you want Elastic Transcoder to save thumbnail files: which bucket to use,\nwhich users you want to have access to the files, the type of access you want\nusers to have, and the storage class that you want to assign to the files. If\nyou specify values for `content_config`, you must also specify values for\n`thumbnail_config` even if you don't want to create thumbnails. (You control\nwhether to create thumbnails when you create a job. For more information, see\nThumbnailPattern in the topic Create Job.) If you specify values for\n`content_config` and `thumbnail_config`, omit the OutputBucket object.\n" } }, "type": "object" }, "aws:elastictranscoder/PipelineThumbnailConfig:PipelineThumbnailConfig": { "properties": { "bucket": { "type": "string", "description": "The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.\n" }, "storageClass": { "type": "string", "description": "The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket" ] } } }, "aws:elastictranscoder/PipelineThumbnailConfigPermission:PipelineThumbnailConfigPermission": { "properties": { "accesses": { "type": "array", "items": { "type": "string" }, "description": "The permission that you want to give to the AWS user that you specified in `thumbnail_config_permissions.grantee`. Valid values are `Read`, `ReadAcp`, `WriteAcp` or `FullControl`.\n" }, "grantee": { "type": "string", "description": "The AWS user or group that you want to have access to thumbnail files.\n" }, "granteeType": { "type": "string", "description": "Specify the type of value that appears in the `thumbnail_config_permissions.grantee` object. Valid values are `Canonical`, `Email` or `Group`.\n" } }, "type": "object" }, "aws:elastictranscoder/PresetAudio:PresetAudio": { "properties": { "audioPackingMode": { "type": "string", "description": "The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.\n", "willReplaceOnChanges": true }, "bitRate": { "type": "string", "description": "The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.\n", "willReplaceOnChanges": true }, "channels": { "type": "string", "description": "The number of audio channels in the output file\n", "willReplaceOnChanges": true }, "codec": { "type": "string", "description": "The audio codec for the output file. Valid values are `AAC`, `flac`, `mp2`, `mp3`, `pcm`, and `vorbis`.\n", "willReplaceOnChanges": true }, "sampleRate": { "type": "string", "description": "The sample rate of the audio stream in the output file, in hertz. Valid values are: `auto`, `22050`, `32000`, `44100`, `48000`, `96000`\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bitRate" ] } } }, "aws:elastictranscoder/PresetAudioCodecOptions:PresetAudioCodecOptions": { "properties": { "bitDepth": { "type": "string", "description": "The bit depth of a sample is how many bits of information are included in the audio samples. Valid values are `16` and `24`. (FLAC/PCM Only)\n", "willReplaceOnChanges": true }, "bitOrder": { "type": "string", "description": "The order the bits of a PCM sample are stored in. The supported value is LittleEndian. (PCM Only)\n", "willReplaceOnChanges": true }, "profile": { "type": "string", "description": "If you specified AAC for Audio:Codec, choose the AAC profile for the output file.\n", "willReplaceOnChanges": true }, "signed": { "type": "string", "description": "Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned). The supported value is Signed. (PCM Only)\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bitDepth", "bitOrder", "profile", "signed" ] } } }, "aws:elastictranscoder/PresetThumbnails:PresetThumbnails": { "properties": { "aspectRatio": { "type": "string", "description": "The aspect ratio of thumbnails. The following values are valid: auto, 1:1, 4:3, 3:2, 16:9\n", "willReplaceOnChanges": true }, "format": { "type": "string", "description": "The format of thumbnails, if any. Valid formats are jpg and png.\n", "willReplaceOnChanges": true }, "interval": { "type": "string", "description": "The approximate number of seconds between thumbnails. The value must be an integer. The actual interval can vary by several seconds from one thumbnail to the next.\n", "willReplaceOnChanges": true }, "maxHeight": { "type": "string", "description": "The maximum height of thumbnails, in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.\n", "willReplaceOnChanges": true }, "maxWidth": { "type": "string", "description": "The maximum width of thumbnails, in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.\n", "willReplaceOnChanges": true }, "paddingPolicy": { "type": "string", "description": "When you set PaddingPolicy to Pad, Elastic Transcoder might add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.\n", "willReplaceOnChanges": true }, "resolution": { "type": "string", "description": "The width and height of thumbnail files in pixels, in the format WidthxHeight, where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object. (To better control resolution and aspect ratio of thumbnails, we recommend that you use the thumbnail values `max_width`, `max_height`, `sizing_policy`, and `padding_policy` instead of `resolution` and `aspect_ratio`. The two groups of settings are mutually exclusive. Do not use them together)\n", "willReplaceOnChanges": true }, "sizingPolicy": { "type": "string", "description": "A value that controls scaling of thumbnails. Valid values are: `Fit`, `Fill`, `Stretch`, `Keep`, `ShrinkToFit`, and `ShrinkToFill`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:elastictranscoder/PresetVideo:PresetVideo": { "properties": { "aspectRatio": { "type": "string", "description": "The display aspect ratio of the video in the output file. Valid values are: `auto`, `1:1`, `4:3`, `3:2`, `16:9`. (Note; to better control resolution and aspect ratio of output videos, we recommend that you use the values `max_width`, `max_height`, `sizing_policy`, `padding_policy`, and `display_aspect_ratio` instead of `resolution` and `aspect_ratio`.)\n", "willReplaceOnChanges": true }, "bitRate": { "type": "string", "description": "The bit rate of the video stream in the output file, in kilobits/second. You can configure variable bit rate or constant bit rate encoding.\n", "willReplaceOnChanges": true }, "codec": { "type": "string", "description": "The video codec for the output file. Valid values are `gif`, `H.264`, `mpeg2`, `vp8`, and `vp9`.\n", "willReplaceOnChanges": true }, "displayAspectRatio": { "type": "string", "description": "The value that Elastic Transcoder adds to the metadata in the output file. If you set DisplayAspectRatio to auto, Elastic Transcoder chooses an aspect ratio that ensures square pixels. If you specify another option, Elastic Transcoder sets that value in the output file.\n", "willReplaceOnChanges": true }, "fixedGop": { "type": "string", "description": "Whether to use a fixed value for Video:FixedGOP. Not applicable for containers of type gif. Valid values are true and false. Also known as, Fixed Number of Frames Between Keyframes.\n", "willReplaceOnChanges": true }, "frameRate": { "type": "string", "description": "The frames per second for the video stream in the output file. The following values are valid: `auto`, `10`, `15`, `23.97`, `24`, `25`, `29.97`, `30`, `50`, `60`.\n", "willReplaceOnChanges": true }, "keyframesMaxDist": { "type": "string", "description": "The maximum number of frames between key frames. Not applicable for containers of type gif.\n", "willReplaceOnChanges": true }, "maxFrameRate": { "type": "string", "description": "If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video, up to the maximum frame rate. If you do not specify a MaxFrameRate, Elastic Transcoder will use a default of 30.\n", "willReplaceOnChanges": true }, "maxHeight": { "type": "string", "description": "The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072, inclusive.\n", "willReplaceOnChanges": true }, "maxWidth": { "type": "string", "description": "The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096, inclusive.\n", "willReplaceOnChanges": true }, "paddingPolicy": { "type": "string", "description": "When you set PaddingPolicy to Pad, Elastic Transcoder might add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for `max_width` and `max_height`.\n", "willReplaceOnChanges": true }, "resolution": { "type": "string", "description": "The width and height of the video in the output file, in pixels. Valid values are `auto` and `widthxheight`. (see note for `aspect_ratio`)\n", "willReplaceOnChanges": true }, "sizingPolicy": { "type": "string", "description": "A value that controls scaling of the output video. Valid values are: `Fit`, `Fill`, `Stretch`, `Keep`, `ShrinkToFit`, `ShrinkToFill`.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bitRate", "maxFrameRate" ] } } }, "aws:elastictranscoder/PresetVideoWatermark:PresetVideoWatermark": { "properties": { "horizontalAlign": { "type": "string", "description": "The horizontal position of the watermark unless you specify a nonzero value for `horzontal_offset`.\n", "willReplaceOnChanges": true }, "horizontalOffset": { "type": "string", "description": "The amount by which you want the horizontal position of the watermark to be offset from the position specified by `horizontal_align`.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long. You can specify settings for up to four watermarks.\n", "willReplaceOnChanges": true }, "maxHeight": { "type": "string", "description": "The maximum height of the watermark.\n", "willReplaceOnChanges": true }, "maxWidth": { "type": "string", "description": "The maximum width of the watermark.\n", "willReplaceOnChanges": true }, "opacity": { "type": "string", "description": "A percentage that indicates how much you want a watermark to obscure the video in the location where it appears.\n", "willReplaceOnChanges": true }, "sizingPolicy": { "type": "string", "description": "A value that controls scaling of the watermark. Valid values are: `Fit`, `Stretch`, `ShrinkToFit`\n", "willReplaceOnChanges": true }, "target": { "type": "string", "description": "A value that determines how Elastic Transcoder interprets values that you specified for `video_watermarks.horizontal_offset`, `video_watermarks.vertical_offset`, `video_watermarks.max_width`, and `video_watermarks.max_height`. Valid values are `Content` and `Frame`.\n", "willReplaceOnChanges": true }, "verticalAlign": { "type": "string", "description": "The vertical position of the watermark unless you specify a nonzero value for `vertical_align`. Valid values are `Top`, `Bottom`, `Center`.\n", "willReplaceOnChanges": true }, "verticalOffset": { "type": "string", "description": "The amount by which you want the vertical position of the watermark to be offset from the position specified by `vertical_align`\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:elb/LoadBalancerAccessLogs:LoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string", "description": "The S3 bucket name to store the logs in.\n" }, "bucketPrefix": { "type": "string", "description": "The S3 bucket prefix. Logs are stored in the root if not configured.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `access_logs`. Default is `true`\n" }, "interval": { "type": "integer", "description": "The publishing interval in minutes. Valid values: `5` and `60`. Default: `60`\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:elb/LoadBalancerHealthCheck:LoadBalancerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer", "description": "The number of checks before the instance is declared healthy.\n" }, "interval": { "type": "integer", "description": "The interval between checks.\n" }, "target": { "type": "string", "description": "The target of the check. Valid pattern is \"${PROTOCOL}:${PORT}${PATH}\", where PROTOCOL\nvalues are:\n* `HTTP`, `HTTPS` - PORT and PATH are required\n* `TCP`, `SSL` - PORT is required, PATH is not supported\n" }, "timeout": { "type": "integer", "description": "The length of time before the check times out.\n" }, "unhealthyThreshold": { "type": "integer", "description": "The number of checks before the instance is declared unhealthy.\n" } }, "type": "object", "required": [ "healthyThreshold", "interval", "target", "timeout", "unhealthyThreshold" ] }, "aws:elb/LoadBalancerListener:LoadBalancerListener": { "properties": { "instancePort": { "type": "integer", "description": "The port on the instance to route to\n" }, "instanceProtocol": { "type": "string", "description": "The protocol to use to the instance. Valid\nvalues are `HTTP`, `HTTPS`, `TCP`, or `SSL`\n" }, "lbPort": { "type": "integer", "description": "The port to listen on for the load balancer\n" }, "lbProtocol": { "type": "string", "description": "The protocol to listen on. Valid values are `HTTP`,\n`HTTPS`, `TCP`, or `SSL`\n" }, "sslCertificateId": { "type": "string", "description": "The ARN of an SSL certificate you have\nuploaded to AWS IAM. **Note ECDSA-specific restrictions below. Only valid when `lb_protocol` is either HTTPS or SSL**\n" } }, "type": "object", "required": [ "instancePort", "instanceProtocol", "lbPort", "lbProtocol" ] }, "aws:elb/LoadBalancerPolicyPolicyAttribute:LoadBalancerPolicyPolicyAttribute": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "aws:elb/SslNegotiationPolicyAttribute:SslNegotiationPolicyAttribute": { "properties": { "name": { "type": "string", "description": "The name of the attribute\n" }, "value": { "type": "string", "description": "The value of the attribute\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:elb/getLoadBalancerAccessLogs:getLoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string" }, "bucketPrefix": { "type": "string" }, "enabled": { "type": "boolean" }, "interval": { "type": "integer" } }, "type": "object", "required": [ "bucket", "bucketPrefix", "enabled", "interval" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elb/getLoadBalancerHealthCheck:getLoadBalancerHealthCheck": { "properties": { "healthyThreshold": { "type": "integer" }, "interval": { "type": "integer" }, "target": { "type": "string" }, "timeout": { "type": "integer" }, "unhealthyThreshold": { "type": "integer" } }, "type": "object", "required": [ "healthyThreshold", "interval", "target", "timeout", "unhealthyThreshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:elb/getLoadBalancerListener:getLoadBalancerListener": { "properties": { "instancePort": { "type": "integer" }, "instanceProtocol": { "type": "string" }, "lbPort": { "type": "integer" }, "lbProtocol": { "type": "string" }, "sslCertificateId": { "type": "string" } }, "type": "object", "required": [ "instancePort", "instanceProtocol", "lbPort", "lbProtocol", "sslCertificateId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:emr/BlockPublicAccessConfigurationPermittedPublicSecurityGroupRuleRange:BlockPublicAccessConfigurationPermittedPublicSecurityGroupRuleRange": { "properties": { "maxRange": { "type": "integer", "description": "The final port in the range of TCP ports.\n" }, "minRange": { "type": "integer", "description": "The first port in the range of TCP ports.\n" } }, "type": "object", "required": [ "maxRange", "minRange" ] }, "aws:emr/ClusterAutoTerminationPolicy:ClusterAutoTerminationPolicy": { "properties": { "idleTimeout": { "type": "integer", "description": "Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of `60` seconds and a maximum of `604800` seconds (seven days).\n" } }, "type": "object" }, "aws:emr/ClusterBootstrapAction:ClusterBootstrapAction": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "List of command line arguments to pass to the bootstrap action script.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the bootstrap action.\n" }, "path": { "type": "string", "description": "Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.\n" } }, "type": "object", "required": [ "name", "path" ] }, "aws:emr/ClusterCoreInstanceFleet:ClusterCoreInstanceFleet": { "properties": { "id": { "type": "string", "description": "ID of the cluster.\n" }, "instanceTypeConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetInstanceTypeConfig:ClusterCoreInstanceFleetInstanceTypeConfig" }, "description": "Configuration block for instance fleet.\n", "willReplaceOnChanges": true }, "launchSpecifications": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetLaunchSpecifications:ClusterCoreInstanceFleetLaunchSpecifications", "description": "Configuration block for launch specification.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Friendly name given to the instance fleet.\n", "willReplaceOnChanges": true }, "provisionedOnDemandCapacity": { "type": "integer" }, "provisionedSpotCapacity": { "type": "integer" }, "targetOnDemandCapacity": { "type": "integer", "description": "The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.\n", "willReplaceOnChanges": true }, "targetSpotCapacity": { "type": "integer", "description": "Target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "provisionedOnDemandCapacity", "provisionedSpotCapacity" ] } } }, "aws:emr/ClusterCoreInstanceFleetInstanceTypeConfig:ClusterCoreInstanceFleetInstanceTypeConfig": { "properties": { "bidPrice": { "type": "string", "description": "Bid price for each EC2 Spot instance type as defined by `instance_type`. Expressed in USD. If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "bidPriceAsPercentageOfOnDemandPrice": { "type": "number", "description": "Bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by `instance_type`. Expressed as a number (for example, 20 specifies 20%). If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "configurations": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetInstanceTypeConfigConfiguration:ClusterCoreInstanceFleetInstanceTypeConfigConfiguration" }, "description": "Configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. List of `configuration` blocks.\n", "willReplaceOnChanges": true }, "ebsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetInstanceTypeConfigEbsConfig:ClusterCoreInstanceFleetInstanceTypeConfigEbsConfig" }, "description": "Configuration block(s) for EBS volumes attached to each instance in the instance group. Detailed below.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "EC2 instance type, such as m4.xlarge.\n", "willReplaceOnChanges": true }, "weightedCapacity": { "type": "integer", "description": "Number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in `aws.emr.InstanceFleet`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ebsConfigs", "instanceType" ] } } }, "aws:emr/ClusterCoreInstanceFleetInstanceTypeConfigConfiguration:ClusterCoreInstanceFleetInstanceTypeConfigConfiguration": { "properties": { "classification": { "type": "string", "description": "Classification within a configuration.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of properties specified within a configuration classification.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/ClusterCoreInstanceFleetInstanceTypeConfigEbsConfig:ClusterCoreInstanceFleetInstanceTypeConfigEbsConfig": { "properties": { "iops": { "type": "integer", "description": "Number of I/O operations per second (IOPS) that the volume supports.\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "Volume size, in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Volume type. Valid options are `gp3`, `gp2`, `io1`, `io2`, `standard`, `st1` and `sc1`. See [EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html).\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "Number of EBS volumes with this configuration to attach to each EC2 instance in the instance group (default is 1).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/ClusterCoreInstanceFleetLaunchSpecifications:ClusterCoreInstanceFleetLaunchSpecifications": { "properties": { "onDemandSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetLaunchSpecificationsOnDemandSpecification:ClusterCoreInstanceFleetLaunchSpecificationsOnDemandSpecification" }, "description": "Configuration block for on demand instances launch specifications.\n", "willReplaceOnChanges": true }, "spotSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceFleetLaunchSpecificationsSpotSpecification:ClusterCoreInstanceFleetLaunchSpecificationsSpotSpecification" }, "description": "Configuration block for spot instances launch specifications.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/ClusterCoreInstanceFleetLaunchSpecificationsOnDemandSpecification:ClusterCoreInstanceFleetLaunchSpecificationsOnDemandSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is `lowest-price` (the default), which launches the lowest price first.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy" ] }, "aws:emr/ClusterCoreInstanceFleetLaunchSpecificationsSpotSpecification:ClusterCoreInstanceFleetLaunchSpecificationsSpotSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies the strategy to use in launching Spot instance fleets. Valid values include `capacity-optimized`, `diversified`, `lowest-price`, `price-capacity-optimized`. See the [AWS documentation](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html#emr-instance-fleet-allocation-strategy) for details on each strategy type.\n", "willReplaceOnChanges": true }, "blockDurationMinutes": { "type": "integer", "description": "Defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.\n", "willReplaceOnChanges": true }, "timeoutAction": { "type": "string", "description": "Action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are `TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.\n", "willReplaceOnChanges": true }, "timeoutDurationMinutes": { "type": "integer", "description": "Spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy", "timeoutAction", "timeoutDurationMinutes" ] }, "aws:emr/ClusterCoreInstanceGroup:ClusterCoreInstanceGroup": { "properties": { "autoscalingPolicy": { "type": "string", "description": "String containing the [EMR Auto Scaling Policy](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html) JSON.\n" }, "bidPrice": { "type": "string", "description": "Bid price for each EC2 instance in the instance group, expressed in USD. By setting this attribute, the instance group is being declared as a Spot Instance, and will implicitly create a Spot request. Leave this blank to use On-Demand Instances.\n", "willReplaceOnChanges": true }, "ebsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterCoreInstanceGroupEbsConfig:ClusterCoreInstanceGroupEbsConfig" }, "description": "Configuration block(s) for EBS volumes attached to each instance in the instance group. Detailed below.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "Core node type Instance Group ID, if using Instance Group for this node type.\n" }, "instanceCount": { "type": "integer", "description": "Target number of instances for the instance group. Must be at least 1. Defaults to 1.\n" }, "instanceType": { "type": "string", "description": "EC2 instance type for all instances in the instance group.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Friendly name given to the instance group.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ebsConfigs", "id", "instanceType" ] } } }, "aws:emr/ClusterCoreInstanceGroupEbsConfig:ClusterCoreInstanceGroupEbsConfig": { "properties": { "iops": { "type": "integer", "description": "Number of I/O operations per second (IOPS) that the volume supports.\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "Volume size, in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "description": "The throughput, in mebibyte per second (MiB/s).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Volume type. Valid options are `gp3`, `gp2`, `io1`, `io2`, `standard`, `st1` and `sc1`. See [EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html).\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "Number of EBS volumes with this configuration to attach to each EC2 instance in the instance group (default is 1).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/ClusterEc2Attributes:ClusterEc2Attributes": { "properties": { "additionalMasterSecurityGroups": { "type": "string", "description": "String containing a comma separated list of additional Amazon EC2 security group IDs for the master node.\n", "willReplaceOnChanges": true }, "additionalSlaveSecurityGroups": { "type": "string", "description": "String containing a comma separated list of additional Amazon EC2 security group IDs for the slave nodes as a comma separated string.\n", "willReplaceOnChanges": true }, "emrManagedMasterSecurityGroup": { "type": "string", "description": "Identifier of the Amazon EC2 EMR-Managed security group for the master node.\n", "willReplaceOnChanges": true }, "emrManagedSlaveSecurityGroup": { "type": "string", "description": "Identifier of the Amazon EC2 EMR-Managed security group for the slave nodes.\n", "willReplaceOnChanges": true }, "instanceProfile": { "type": "string", "description": "Instance Profile for EC2 instances of the cluster assume this role.\n", "willReplaceOnChanges": true }, "keyName": { "type": "string", "description": "Amazon EC2 key pair that can be used to ssh to the master node as the user called `hadoop`.\n", "willReplaceOnChanges": true }, "serviceAccessSecurityGroup": { "type": "string", "description": "Identifier of the Amazon EC2 service-access security group - required when the cluster runs on a private subnet.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "VPC subnet id where you want the job flow to launch. Cannot specify the `cc1.4xlarge` instance type for nodes of a job flow launched in an Amazon VPC.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC subnet id-s where you want the job flow to launch. Amazon EMR identifies the best Availability Zone to launch instances according to your fleet specifications.\n\n\u003e **NOTE on EMR-Managed security groups:** These security groups will have any missing inbound or outbound access rules added and maintained by AWS, to ensure proper communication between instances in a cluster. The EMR service will maintain these rules for groups provided in `emr_managed_master_security_group` and `emr_managed_slave_security_group`; attempts to remove the required rules may succeed, only for the EMR service to re-add them in a matter of minutes. This may cause this provider to fail to destroy an environment that contains an EMR cluster, because the EMR service does not revoke rules added on deletion, leaving a cyclic dependency between the security groups that prevents their deletion. To avoid this, use the `revoke_rules_on_delete` optional attribute for any Security Group used in `emr_managed_master_security_group` and `emr_managed_slave_security_group`. See [Amazon EMR-Managed Security Groups](http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-man-sec-groups.html) for more information about the EMR-managed security group rules.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceProfile" ], "language": { "nodejs": { "requiredOutputs": [ "emrManagedMasterSecurityGroup", "emrManagedSlaveSecurityGroup", "instanceProfile", "serviceAccessSecurityGroup", "subnetId", "subnetIds" ] } } }, "aws:emr/ClusterKerberosAttributes:ClusterKerberosAttributes": { "properties": { "adDomainJoinPassword": { "type": "string", "description": "Active Directory password for `ad_domain_join_user`. This provider cannot perform drift detection of this configuration.\n", "secret": true, "willReplaceOnChanges": true }, "adDomainJoinUser": { "type": "string", "description": "Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain. This provider cannot perform drift detection of this configuration.\n", "willReplaceOnChanges": true }, "crossRealmTrustPrincipalPassword": { "type": "string", "description": "Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms. This provider cannot perform drift detection of this configuration.\n", "secret": true, "willReplaceOnChanges": true }, "kdcAdminPassword": { "type": "string", "description": "Password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster. This provider cannot perform drift detection of this configuration.\n", "secret": true, "willReplaceOnChanges": true }, "realm": { "type": "string", "description": "Name of the Kerberos realm to which all nodes in a cluster belong. For example, `EC2.INTERNAL`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "kdcAdminPassword", "realm" ] }, "aws:emr/ClusterMasterInstanceFleet:ClusterMasterInstanceFleet": { "properties": { "id": { "type": "string", "description": "ID of the cluster.\n" }, "instanceTypeConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetInstanceTypeConfig:ClusterMasterInstanceFleetInstanceTypeConfig" }, "description": "Configuration block for instance fleet.\n", "willReplaceOnChanges": true }, "launchSpecifications": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetLaunchSpecifications:ClusterMasterInstanceFleetLaunchSpecifications", "description": "Configuration block for launch specification.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Friendly name given to the instance fleet.\n", "willReplaceOnChanges": true }, "provisionedOnDemandCapacity": { "type": "integer" }, "provisionedSpotCapacity": { "type": "integer" }, "targetOnDemandCapacity": { "type": "integer", "description": "Target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.\n", "willReplaceOnChanges": true }, "targetSpotCapacity": { "type": "integer", "description": "Target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "provisionedOnDemandCapacity", "provisionedSpotCapacity" ] } } }, "aws:emr/ClusterMasterInstanceFleetInstanceTypeConfig:ClusterMasterInstanceFleetInstanceTypeConfig": { "properties": { "bidPrice": { "type": "string", "description": "Bid price for each EC2 Spot instance type as defined by `instance_type`. Expressed in USD. If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "bidPriceAsPercentageOfOnDemandPrice": { "type": "number", "description": "Bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by `instance_type`. Expressed as a number (for example, 20 specifies 20%). If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "configurations": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetInstanceTypeConfigConfiguration:ClusterMasterInstanceFleetInstanceTypeConfigConfiguration" }, "description": "Configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. List of `configuration` blocks.\n", "willReplaceOnChanges": true }, "ebsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetInstanceTypeConfigEbsConfig:ClusterMasterInstanceFleetInstanceTypeConfigEbsConfig" }, "description": "Configuration block(s) for EBS volumes attached to each instance in the instance group. Detailed below.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "EC2 instance type, such as m4.xlarge.\n", "willReplaceOnChanges": true }, "weightedCapacity": { "type": "integer", "description": "Number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in `aws.emr.InstanceFleet`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ebsConfigs", "instanceType" ] } } }, "aws:emr/ClusterMasterInstanceFleetInstanceTypeConfigConfiguration:ClusterMasterInstanceFleetInstanceTypeConfigConfiguration": { "properties": { "classification": { "type": "string", "description": "Classification within a configuration.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of properties specified within a configuration classification.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/ClusterMasterInstanceFleetInstanceTypeConfigEbsConfig:ClusterMasterInstanceFleetInstanceTypeConfigEbsConfig": { "properties": { "iops": { "type": "integer", "description": "Number of I/O operations per second (IOPS) that the volume supports.\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "Volume size, in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Volume type. Valid options are `gp3`, `gp2`, `io1`, `io2`, `standard`, `st1` and `sc1`. See [EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html).\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "Number of EBS volumes with this configuration to attach to each EC2 instance in the instance group (default is 1).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/ClusterMasterInstanceFleetLaunchSpecifications:ClusterMasterInstanceFleetLaunchSpecifications": { "properties": { "onDemandSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetLaunchSpecificationsOnDemandSpecification:ClusterMasterInstanceFleetLaunchSpecificationsOnDemandSpecification" }, "description": "Configuration block for on demand instances launch specifications.\n", "willReplaceOnChanges": true }, "spotSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceFleetLaunchSpecificationsSpotSpecification:ClusterMasterInstanceFleetLaunchSpecificationsSpotSpecification" }, "description": "Configuration block for spot instances launch specifications.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/ClusterMasterInstanceFleetLaunchSpecificationsOnDemandSpecification:ClusterMasterInstanceFleetLaunchSpecificationsOnDemandSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is `lowest-price` (the default), which launches the lowest price first.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy" ] }, "aws:emr/ClusterMasterInstanceFleetLaunchSpecificationsSpotSpecification:ClusterMasterInstanceFleetLaunchSpecificationsSpotSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies the strategy to use in launching Spot instance fleets. Valid values include `capacity-optimized`, `diversified`, `lowest-price`, `price-capacity-optimized`. See the [AWS documentation](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html#emr-instance-fleet-allocation-strategy) for details on each strategy type.\n", "willReplaceOnChanges": true }, "blockDurationMinutes": { "type": "integer", "description": "Defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.\n", "willReplaceOnChanges": true }, "timeoutAction": { "type": "string", "description": "Action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are `TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.\n", "willReplaceOnChanges": true }, "timeoutDurationMinutes": { "type": "integer", "description": "Spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy", "timeoutAction", "timeoutDurationMinutes" ] }, "aws:emr/ClusterMasterInstanceGroup:ClusterMasterInstanceGroup": { "properties": { "bidPrice": { "type": "string", "description": "Bid price for each EC2 instance in the instance group, expressed in USD. By setting this attribute, the instance group is being declared as a Spot Instance, and will implicitly create a Spot request. Leave this blank to use On-Demand Instances.\n", "willReplaceOnChanges": true }, "ebsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/ClusterMasterInstanceGroupEbsConfig:ClusterMasterInstanceGroupEbsConfig" }, "description": "Configuration block(s) for EBS volumes attached to each instance in the instance group. Detailed below.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "Master node type Instance Group ID, if using Instance Group for this node type.\n" }, "instanceCount": { "type": "integer", "description": "Target number of instances for the instance group. Must be 1 or 3. Defaults to 1. Launching with multiple master nodes is only supported in EMR version 5.23.0+, and requires this resource's `core_instance_group` to be configured. Public (Internet accessible) instances must be created in VPC subnets that have map public IP on launch enabled. Termination protection is automatically enabled when launched with multiple master nodes and this provider must have the `termination_protection = false` configuration applied before destroying this resource.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "EC2 instance type for all instances in the instance group.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Friendly name given to the instance group.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ebsConfigs", "id", "instanceType" ] } } }, "aws:emr/ClusterMasterInstanceGroupEbsConfig:ClusterMasterInstanceGroupEbsConfig": { "properties": { "iops": { "type": "integer", "description": "Number of I/O operations per second (IOPS) that the volume supports.\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "Volume size, in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "description": "The throughput, in mebibyte per second (MiB/s).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Volume type. Valid options are `gp3`, `gp2`, `io1`, `io2`, `standard`, `st1` and `sc1`. See [EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html).\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "Number of EBS volumes with this configuration to attach to each EC2 instance in the instance group (default is 1).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/ClusterPlacementGroupConfig:ClusterPlacementGroupConfig": { "properties": { "instanceRole": { "type": "string", "description": "Role of the instance in the cluster. Valid Values: `MASTER`, `CORE`, `TASK`.\n", "willReplaceOnChanges": true }, "placementStrategy": { "type": "string", "description": "EC2 Placement Group strategy associated with instance role. Valid Values: `SPREAD`, `PARTITION`, `CLUSTER`, `NONE`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceRole" ], "language": { "nodejs": { "requiredOutputs": [ "instanceRole", "placementStrategy" ] } } }, "aws:emr/ClusterStep:ClusterStep": { "properties": { "actionOnFailure": { "type": "string", "description": "Action to take if the step fails. Valid values: `TERMINATE_JOB_FLOW`, `TERMINATE_CLUSTER`, `CANCEL_AND_WAIT`, and `CONTINUE`\n", "willReplaceOnChanges": true }, "hadoopJarStep": { "$ref": "#/types/aws:emr/ClusterStepHadoopJarStep:ClusterStepHadoopJarStep", "description": "JAR file used for the step. See below.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the step.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "actionOnFailure", "hadoopJarStep", "name" ] }, "aws:emr/ClusterStepHadoopJarStep:ClusterStepHadoopJarStep": { "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "List of command line arguments passed to the JAR file's main function when executed.\n", "willReplaceOnChanges": true }, "jar": { "type": "string", "description": "Path to a JAR file run during the step.\n", "willReplaceOnChanges": true }, "mainClass": { "type": "string", "description": "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.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-Value map of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "jar" ] }, "aws:emr/InstanceFleetInstanceTypeConfig:InstanceFleetInstanceTypeConfig": { "properties": { "bidPrice": { "type": "string", "description": "The bid price for each EC2 Spot instance type as defined by `instance_type`. Expressed in USD. If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "bidPriceAsPercentageOfOnDemandPrice": { "type": "number", "description": "The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by `instance_type`. Expressed as a number (for example, 20 specifies 20%). If neither `bid_price` nor `bid_price_as_percentage_of_on_demand_price` is provided, `bid_price_as_percentage_of_on_demand_price` defaults to 100%.\n", "willReplaceOnChanges": true }, "configurations": { "type": "array", "items": { "$ref": "#/types/aws:emr/InstanceFleetInstanceTypeConfigConfiguration:InstanceFleetInstanceTypeConfigConfiguration" }, "description": "A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. List of `configuration` blocks.\n", "willReplaceOnChanges": true }, "ebsConfigs": { "type": "array", "items": { "$ref": "#/types/aws:emr/InstanceFleetInstanceTypeConfigEbsConfig:InstanceFleetInstanceTypeConfigEbsConfig" }, "description": "Configuration block(s) for EBS volumes attached to each instance in the instance group. Detailed below.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "An EC2 instance type, such as m4.xlarge.\n", "willReplaceOnChanges": true }, "weightedCapacity": { "type": "integer", "description": "The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in `aws.emr.InstanceFleet`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "ebsConfigs", "instanceType" ] } } }, "aws:emr/InstanceFleetInstanceTypeConfigConfiguration:InstanceFleetInstanceTypeConfigConfiguration": { "properties": { "classification": { "type": "string", "description": "The classification within a configuration.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of properties specified within a configuration classification\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/InstanceFleetInstanceTypeConfigEbsConfig:InstanceFleetInstanceTypeConfigEbsConfig": { "properties": { "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS) that the volume supports\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "The volume size, in gibibytes (GiB).\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The volume type. Valid options are `gp2`, `io1`, `standard` and `st1`. See [EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html).\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "The number of EBS volumes with this configuration to attach to each EC2 instance in the instance group (default is 1)\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/InstanceFleetLaunchSpecifications:InstanceFleetLaunchSpecifications": { "properties": { "onDemandSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/InstanceFleetLaunchSpecificationsOnDemandSpecification:InstanceFleetLaunchSpecificationsOnDemandSpecification" }, "description": "Configuration block for on demand instances launch specifications\n", "willReplaceOnChanges": true }, "spotSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:emr/InstanceFleetLaunchSpecificationsSpotSpecification:InstanceFleetLaunchSpecificationsSpotSpecification" }, "description": "Configuration block for spot instances launch specifications\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emr/InstanceFleetLaunchSpecificationsOnDemandSpecification:InstanceFleetLaunchSpecificationsOnDemandSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies one of the following strategies to launch Spot Instance fleets: `price-capacity-optimized`, `capacity-optimized`, `lowest-price`, or `diversified`. For more information on the provisioning strategies, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy" ] }, "aws:emr/InstanceFleetLaunchSpecificationsSpotSpecification:InstanceFleetLaunchSpecificationsSpotSpecification": { "properties": { "allocationStrategy": { "type": "string", "description": "Specifies one of the following strategies to launch Spot Instance fleets: `price-capacity-optimized`, `capacity-optimized`, `lowest-price`, or `diversified`. For more information on the provisioning strategies, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html).\n", "willReplaceOnChanges": true }, "blockDurationMinutes": { "type": "integer", "description": "The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.\n", "willReplaceOnChanges": true }, "timeoutAction": { "type": "string", "description": "The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are `TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.\n", "willReplaceOnChanges": true }, "timeoutDurationMinutes": { "type": "integer", "description": "The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "allocationStrategy", "timeoutAction", "timeoutDurationMinutes" ] }, "aws:emr/InstanceGroupEbsConfig:InstanceGroupEbsConfig": { "properties": { "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS) that the volume supports.\n", "willReplaceOnChanges": true }, "size": { "type": "integer", "description": "The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The volume type. Valid options are 'gp2', 'io1' and 'standard'.\n", "willReplaceOnChanges": true }, "volumesPerInstance": { "type": "integer", "description": "The number of EBS Volumes to attach per instance.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:emr/ManagedScalingPolicyComputeLimit:ManagedScalingPolicyComputeLimit": { "properties": { "maximumCapacityUnits": { "type": "integer", "description": "The upper boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.\n", "willReplaceOnChanges": true }, "maximumCoreCapacityUnits": { "type": "integer", "description": "The upper boundary of EC2 units for core node type in a cluster. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.\n", "willReplaceOnChanges": true }, "maximumOndemandCapacityUnits": { "type": "integer", "description": "The upper boundary of On-Demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot instances.\n", "willReplaceOnChanges": true }, "minimumCapacityUnits": { "type": "integer", "description": "The lower boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.\n", "willReplaceOnChanges": true }, "unitType": { "type": "string", "description": "The unit type used for specifying a managed scaling policy. Valid Values: `InstanceFleetUnits` | `Instances` | `VCPU`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "maximumCapacityUnits", "minimumCapacityUnits", "unitType" ] }, "aws:emr/getReleaseLabelsFilters:getReleaseLabelsFilters": { "properties": { "application": { "type": "string", "description": "Optional release label application filter. For example, `Spark@2.1.0` or `Spark`.\n" }, "prefix": { "type": "string", "description": "Optional release label version prefix filter. For example, `emr-5`.\n" } }, "type": "object" }, "aws:emr/getSupportedInstanceTypesSupportedInstanceType:getSupportedInstanceTypesSupportedInstanceType": { "properties": { "architecture": { "type": "string", "description": "CPU architecture.\n" }, "ebsOptimizedAvailable": { "type": "boolean", "description": "Indicates whether the instance type supports Amazon EBS optimization.\n" }, "ebsOptimizedByDefault": { "type": "boolean", "description": "Indicates whether the instance type uses Amazon EBS optimization by default.\n" }, "ebsStorageOnly": { "type": "boolean", "description": "Indicates whether the instance type only supports Amazon EBS.\n" }, "instanceFamilyId": { "type": "string", "description": "The Amazon EC2 family and generation for the instance type.\n" }, "is64BitsOnly": { "type": "boolean", "description": "Indicates whether the instance type only supports 64-bit architecture.\n" }, "memoryGb": { "type": "number", "description": "Memory that is available to Amazon EMR from the instance type.\n" }, "numberOfDisks": { "type": "integer", "description": "Number of disks for the instance type.\n" }, "storageGb": { "type": "integer", "description": "Storage capacity of the instance type.\n" }, "type": { "type": "string", "description": "Amazon EC2 instance type. For example, `m5.xlarge`.\n" }, "vcpu": { "type": "integer", "description": "The number of vCPUs available for the instance type.\n" } }, "type": "object", "required": [ "architecture", "ebsOptimizedAvailable", "ebsOptimizedByDefault", "ebsStorageOnly", "instanceFamilyId", "is64BitsOnly", "memoryGb", "numberOfDisks", "storageGb", "type", "vcpu" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:emrcontainers/JobTemplateJobTemplateData:JobTemplateJobTemplateData": { "properties": { "configurationOverrides": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverrides:JobTemplateJobTemplateDataConfigurationOverrides", "description": "The configuration settings that are used to override defaults configuration.\n", "willReplaceOnChanges": true }, "executionRoleArn": { "type": "string", "description": "The execution role ARN of the job run.\n", "willReplaceOnChanges": true }, "jobDriver": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataJobDriver:JobTemplateJobTemplateDataJobDriver", "description": "Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.\n", "willReplaceOnChanges": true }, "jobTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The tags assigned to jobs started using the job template.\n", "willReplaceOnChanges": true }, "releaseLabel": { "type": "string", "description": "The release version of Amazon EMR.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "executionRoleArn", "jobDriver", "releaseLabel" ] }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverrides:JobTemplateJobTemplateDataConfigurationOverrides": { "properties": { "applicationConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesApplicationConfiguration:JobTemplateJobTemplateDataConfigurationOverridesApplicationConfiguration" }, "description": "The configurations for the application running by the job run.\n", "willReplaceOnChanges": true }, "monitoringConfiguration": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfiguration", "description": "The configurations for monitoring.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesApplicationConfiguration:JobTemplateJobTemplateDataConfigurationOverridesApplicationConfiguration": { "properties": { "classification": { "type": "string", "description": "The classification within a configuration.\n", "willReplaceOnChanges": true }, "configurations": { "type": "array", "items": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesApplicationConfigurationConfiguration:JobTemplateJobTemplateDataConfigurationOverridesApplicationConfigurationConfiguration" }, "description": "A list of additional configurations to apply within a configuration object.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A set of properties specified within a configuration classification.\n" } }, "type": "object", "required": [ "classification" ] }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesApplicationConfigurationConfiguration:JobTemplateJobTemplateDataConfigurationOverridesApplicationConfigurationConfiguration": { "properties": { "classification": { "type": "string", "description": "The classification within a configuration.\n", "willReplaceOnChanges": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A set of properties specified within a configuration classification.\n" } }, "type": "object" }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfiguration": { "properties": { "cloudWatchMonitoringConfiguration": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationCloudWatchMonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationCloudWatchMonitoringConfiguration", "description": "Monitoring configurations for CloudWatch.\n", "willReplaceOnChanges": true }, "persistentAppUi": { "type": "string", "description": "Monitoring configurations for the persistent application UI.\n", "willReplaceOnChanges": true }, "s3MonitoringConfiguration": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationS3MonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationS3MonitoringConfiguration", "description": "Amazon S3 configuration for monitoring log publishing.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationCloudWatchMonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationCloudWatchMonitoringConfiguration": { "properties": { "logGroupName": { "type": "string", "description": "The name of the log group for log publishing.\n", "willReplaceOnChanges": true }, "logStreamNamePrefix": { "type": "string", "description": "The specified name prefix for log streams.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "logGroupName" ] }, "aws:emrcontainers/JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationS3MonitoringConfiguration:JobTemplateJobTemplateDataConfigurationOverridesMonitoringConfigurationS3MonitoringConfiguration": { "properties": { "logUri": { "type": "string", "description": "Amazon S3 destination URI for log publishing.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "logUri" ] }, "aws:emrcontainers/JobTemplateJobTemplateDataJobDriver:JobTemplateJobTemplateDataJobDriver": { "properties": { "sparkSqlJobDriver": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataJobDriverSparkSqlJobDriver:JobTemplateJobTemplateDataJobDriverSparkSqlJobDriver", "description": "The job driver for job type.\n", "willReplaceOnChanges": true }, "sparkSubmitJobDriver": { "$ref": "#/types/aws:emrcontainers/JobTemplateJobTemplateDataJobDriverSparkSubmitJobDriver:JobTemplateJobTemplateDataJobDriverSparkSubmitJobDriver", "description": "The job driver parameters specified for spark submit.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emrcontainers/JobTemplateJobTemplateDataJobDriverSparkSqlJobDriver:JobTemplateJobTemplateDataJobDriverSparkSqlJobDriver": { "properties": { "entryPoint": { "type": "string", "description": "The SQL file to be executed.\n", "willReplaceOnChanges": true }, "sparkSqlParameters": { "type": "string", "description": "The Spark parameters to be included in the Spark SQL command.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emrcontainers/JobTemplateJobTemplateDataJobDriverSparkSubmitJobDriver:JobTemplateJobTemplateDataJobDriverSparkSubmitJobDriver": { "properties": { "entryPoint": { "type": "string", "description": "The entry point of job application.\n", "willReplaceOnChanges": true }, "entryPointArguments": { "type": "array", "items": { "type": "string" }, "description": "The arguments for job application.\n", "willReplaceOnChanges": true }, "sparkSubmitParameters": { "type": "string", "description": "The Spark submit parameters that are used for job runs.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "entryPoint" ] }, "aws:emrcontainers/VirtualClusterContainerProvider:VirtualClusterContainerProvider": { "properties": { "id": { "type": "string", "description": "The name of the container provider that is running your EMR Containers cluster\n", "willReplaceOnChanges": true }, "info": { "$ref": "#/types/aws:emrcontainers/VirtualClusterContainerProviderInfo:VirtualClusterContainerProviderInfo", "description": "Nested list containing information about the configuration of the container provider\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of the container provider\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "id", "info", "type" ] }, "aws:emrcontainers/VirtualClusterContainerProviderInfo:VirtualClusterContainerProviderInfo": { "properties": { "eksInfo": { "$ref": "#/types/aws:emrcontainers/VirtualClusterContainerProviderInfoEksInfo:VirtualClusterContainerProviderInfoEksInfo", "description": "Nested list containing EKS-specific information about the cluster where the EMR Containers cluster is running\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "eksInfo" ] }, "aws:emrcontainers/VirtualClusterContainerProviderInfoEksInfo:VirtualClusterContainerProviderInfoEksInfo": { "properties": { "namespace": { "type": "string", "description": "The namespace where the EMR Containers cluster is running\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:emrcontainers/getVirtualClusterContainerProvider:getVirtualClusterContainerProvider": { "properties": { "id": { "type": "string", "description": "The name of the container provider that is running your EMR Containers cluster\n" }, "infos": { "type": "array", "items": { "$ref": "#/types/aws:emrcontainers/getVirtualClusterContainerProviderInfo:getVirtualClusterContainerProviderInfo" }, "description": "Nested list containing information about the configuration of the container provider\n" }, "type": { "type": "string", "description": "The type of the container provider\n" } }, "type": "object", "required": [ "id", "infos", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:emrcontainers/getVirtualClusterContainerProviderInfo:getVirtualClusterContainerProviderInfo": { "properties": { "eksInfos": { "type": "array", "items": { "$ref": "#/types/aws:emrcontainers/getVirtualClusterContainerProviderInfoEksInfo:getVirtualClusterContainerProviderInfoEksInfo" }, "description": "Nested list containing EKS-specific information about the cluster where the EMR Containers cluster is running\n" } }, "type": "object", "required": [ "eksInfos" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:emrcontainers/getVirtualClusterContainerProviderInfoEksInfo:getVirtualClusterContainerProviderInfoEksInfo": { "properties": { "namespace": { "type": "string", "description": "The namespace where the EMR Containers cluster is running\n" } }, "type": "object", "required": [ "namespace" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:emrserverless/ApplicationAutoStartConfiguration:ApplicationAutoStartConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables the application to automatically start on job submission. Defaults to `true`.\n" } }, "type": "object" }, "aws:emrserverless/ApplicationAutoStopConfiguration:ApplicationAutoStopConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables the application to automatically stop after a certain amount of time being idle. Defaults to `true`.\n" }, "idleTimeoutMinutes": { "type": "integer", "description": "The amount of idle time in minutes after which your application will automatically stop. Defaults to `15` minutes.\n" } }, "type": "object" }, "aws:emrserverless/ApplicationImageConfiguration:ApplicationImageConfiguration": { "properties": { "imageUri": { "type": "string", "description": "The image URI.\n" } }, "type": "object", "required": [ "imageUri" ] }, "aws:emrserverless/ApplicationInitialCapacity:ApplicationInitialCapacity": { "properties": { "initialCapacityConfig": { "$ref": "#/types/aws:emrserverless/ApplicationInitialCapacityInitialCapacityConfig:ApplicationInitialCapacityInitialCapacityConfig", "description": "The initial capacity configuration per worker.\n" }, "initialCapacityType": { "type": "string", "description": "The worker type for an analytics framework. For Spark applications, the key can either be set to `Driver` or `Executor`. For Hive applications, it can be set to `HiveDriver` or `TezTask`.\n" } }, "type": "object", "required": [ "initialCapacityType" ] }, "aws:emrserverless/ApplicationInitialCapacityInitialCapacityConfig:ApplicationInitialCapacityInitialCapacityConfig": { "properties": { "workerConfiguration": { "$ref": "#/types/aws:emrserverless/ApplicationInitialCapacityInitialCapacityConfigWorkerConfiguration:ApplicationInitialCapacityInitialCapacityConfigWorkerConfiguration", "description": "The resource configuration of the initial capacity configuration.\n" }, "workerCount": { "type": "integer", "description": "The number of workers in the initial capacity configuration.\n" } }, "type": "object", "required": [ "workerCount" ] }, "aws:emrserverless/ApplicationInitialCapacityInitialCapacityConfigWorkerConfiguration:ApplicationInitialCapacityInitialCapacityConfigWorkerConfiguration": { "properties": { "cpu": { "type": "string", "description": "The CPU requirements for every worker instance of the worker type.\n" }, "disk": { "type": "string", "description": "The disk requirements for every worker instance of the worker type.\n" }, "memory": { "type": "string", "description": "The memory requirements for every worker instance of the worker type.\n" } }, "type": "object", "required": [ "cpu", "memory" ], "language": { "nodejs": { "requiredOutputs": [ "cpu", "disk", "memory" ] } } }, "aws:emrserverless/ApplicationInteractiveConfiguration:ApplicationInteractiveConfiguration": { "properties": { "livyEndpointEnabled": { "type": "boolean", "description": "Enables an Apache Livy endpoint that you can connect to and run interactive jobs.\n" }, "studioEnabled": { "type": "boolean", "description": "Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "livyEndpointEnabled", "studioEnabled" ] } } }, "aws:emrserverless/ApplicationMaximumCapacity:ApplicationMaximumCapacity": { "properties": { "cpu": { "type": "string", "description": "The maximum allowed CPU for an application.\n" }, "disk": { "type": "string", "description": "The maximum allowed disk for an application.\n" }, "memory": { "type": "string", "description": "The maximum allowed resources for an application.\n" } }, "type": "object", "required": [ "cpu", "memory" ], "language": { "nodejs": { "requiredOutputs": [ "cpu", "disk", "memory" ] } } }, "aws:emrserverless/ApplicationNetworkConfiguration:ApplicationNetworkConfiguration": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The array of security group Ids for customer VPC connectivity.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The array of subnet Ids for customer VPC connectivity.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:evidently/FeatureEvaluationRule:FeatureEvaluationRule": { "properties": { "name": { "type": "string", "description": "The name for the new feature. Minimum length of `1`. Maximum length of `127`.\n" }, "type": { "type": "string", "description": "This value is `aws.evidently.splits` if this is an evaluation rule for a launch, and it is `aws.evidently.onlineab` if this is an evaluation rule for an experiment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "type" ] } } }, "aws:evidently/FeatureVariation:FeatureVariation": { "properties": { "name": { "type": "string", "description": "The name of the variation. Minimum length of `1`. Maximum length of `127`.\n" }, "value": { "$ref": "#/types/aws:evidently/FeatureVariationValue:FeatureVariationValue", "description": "A block that specifies the value assigned to this variation. Detailed below\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:evidently/FeatureVariationValue:FeatureVariationValue": { "properties": { "boolValue": { "type": "string", "description": "If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.\n" }, "doubleValue": { "type": "string", "description": "If this feature uses the double integer variation type, this field contains the double integer value of this variation.\n" }, "longValue": { "type": "string", "description": "If this feature uses the long variation type, this field contains the long value of this variation. Minimum value of `-9007199254740991`. Maximum value of `9007199254740991`.\n" }, "stringValue": { "type": "string", "description": "If this feature uses the string variation type, this field contains the string value of this variation. Minimum length of `0`. Maximum length of `512`.\n" } }, "type": "object" }, "aws:evidently/LaunchExecution:LaunchExecution": { "properties": { "endedTime": { "type": "string", "description": "The date and time that the launch ended.\n" }, "startedTime": { "type": "string", "description": "The date and time that the launch started.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endedTime", "startedTime" ] } } }, "aws:evidently/LaunchGroup:LaunchGroup": { "properties": { "description": { "type": "string", "description": "Specifies the description of the launch group.\n" }, "feature": { "type": "string", "description": "Specifies the name of the feature that the launch is using.\n" }, "name": { "type": "string", "description": "Specifies the name of the lahnch group.\n" }, "variation": { "type": "string", "description": "Specifies the feature variation to use for this launch group.\n" } }, "type": "object", "required": [ "feature", "name", "variation" ] }, "aws:evidently/LaunchMetricMonitor:LaunchMetricMonitor": { "properties": { "metricDefinition": { "$ref": "#/types/aws:evidently/LaunchMetricMonitorMetricDefinition:LaunchMetricMonitorMetricDefinition", "description": "A block that defines the metric. Detailed below.\n" } }, "type": "object", "required": [ "metricDefinition" ] }, "aws:evidently/LaunchMetricMonitorMetricDefinition:LaunchMetricMonitorMetricDefinition": { "properties": { "entityIdKey": { "type": "string", "description": "Specifies the entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is `userDetails.userID`.\n" }, "eventPattern": { "type": "string", "description": "Specifies The EventBridge event pattern that defines how the metric is recorded.\n" }, "name": { "type": "string", "description": "Specifies the name for the metric.\n" }, "unitLabel": { "type": "string", "description": "Specifies a label for the units that the metric is measuring.\n" }, "valueKey": { "type": "string", "description": "Specifies the value that is tracked to produce the metric.\n" } }, "type": "object", "required": [ "entityIdKey", "name", "valueKey" ] }, "aws:evidently/LaunchScheduledSplitsConfig:LaunchScheduledSplitsConfig": { "properties": { "steps": { "type": "array", "items": { "$ref": "#/types/aws:evidently/LaunchScheduledSplitsConfigStep:LaunchScheduledSplitsConfigStep" }, "description": "One or up to six blocks that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step. Detailed below.\n" } }, "type": "object", "required": [ "steps" ] }, "aws:evidently/LaunchScheduledSplitsConfigStep:LaunchScheduledSplitsConfigStep": { "properties": { "groupWeights": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step. For more information, refer to the [AWS documentation for ScheduledSplitConfig groupWeights](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ScheduledSplitConfig.html).\n" }, "segmentOverrides": { "type": "array", "items": { "$ref": "#/types/aws:evidently/LaunchScheduledSplitsConfigStepSegmentOverride:LaunchScheduledSplitsConfigStepSegmentOverride" }, "description": "One or up to six blocks that 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. Detailed below.\n" }, "startTime": { "type": "string", "description": "Specifies the date and time that this step of the launch starts.\n" } }, "type": "object", "required": [ "groupWeights", "startTime" ] }, "aws:evidently/LaunchScheduledSplitsConfigStepSegmentOverride:LaunchScheduledSplitsConfigStepSegmentOverride": { "properties": { "evaluationOrder": { "type": "integer", "description": "Specifies 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.\n" }, "segment": { "type": "string", "description": "The name or ARN of the segment to use.\n" }, "weights": { "type": "object", "additionalProperties": { "type": "integer" }, "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.\n" } }, "type": "object", "required": [ "evaluationOrder", "segment", "weights" ] }, "aws:evidently/ProjectDataDelivery:ProjectDataDelivery": { "properties": { "cloudwatchLogs": { "$ref": "#/types/aws:evidently/ProjectDataDeliveryCloudwatchLogs:ProjectDataDeliveryCloudwatchLogs", "description": "A block that defines the CloudWatch Log Group that stores the evaluation events. See below.\n" }, "s3Destination": { "$ref": "#/types/aws:evidently/ProjectDataDeliveryS3Destination:ProjectDataDeliveryS3Destination", "description": "A block that defines the S3 bucket and prefix that stores the evaluation events. See below.\n" } }, "type": "object" }, "aws:evidently/ProjectDataDeliveryCloudwatchLogs:ProjectDataDeliveryCloudwatchLogs": { "properties": { "logGroup": { "type": "string", "description": "The name of the log group where the project stores evaluation events.\n" } }, "type": "object" }, "aws:evidently/ProjectDataDeliveryS3Destination:ProjectDataDeliveryS3Destination": { "properties": { "bucket": { "type": "string", "description": "The name of the bucket in which Evidently stores evaluation events.\n" }, "prefix": { "type": "string", "description": "The bucket prefix in which Evidently stores evaluation events.\n" } }, "type": "object" }, "aws:finspace/KxClusterAutoScalingConfiguration:KxClusterAutoScalingConfiguration": { "properties": { "autoScalingMetric": { "type": "string", "description": "Metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all nodes in a cluster.\n", "willReplaceOnChanges": true }, "maxNodeCount": { "type": "integer", "description": "Highest number of nodes to scale. Cannot be greater than 5\n", "willReplaceOnChanges": true }, "metricTarget": { "type": "number", "description": "Desired value of chosen `auto_scaling_metric`. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.\n", "willReplaceOnChanges": true }, "minNodeCount": { "type": "integer", "description": "Lowest number of nodes to scale. Must be at least 1 and less than the `max_node_count`. If nodes in cluster belong to multiple availability zones, then `min_node_count` must be at least 3.\n", "willReplaceOnChanges": true }, "scaleInCooldownSeconds": { "type": "number", "description": "Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.\n", "willReplaceOnChanges": true }, "scaleOutCooldownSeconds": { "type": "number", "description": "Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "autoScalingMetric", "maxNodeCount", "metricTarget", "minNodeCount", "scaleInCooldownSeconds", "scaleOutCooldownSeconds" ] }, "aws:finspace/KxClusterCacheStorageConfiguration:KxClusterCacheStorageConfiguration": { "properties": { "size": { "type": "integer", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of KDB database. The following types are available:\n* HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.\n* RDB - Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the `savedownStorageConfiguration` parameter.\n* GATEWAY - A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.\n* GP - A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only `SINGLE` AZ mode.\n* Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:finspace/KxClusterCapacityConfiguration:KxClusterCapacityConfiguration": { "properties": { "nodeCount": { "type": "integer", "description": "Number of instances running in a cluster. Must be at least 1 and at most 5.\n", "willReplaceOnChanges": true }, "nodeType": { "type": "string", "description": "Determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.\n\nYou can only specify one of the following values:\n* kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.\n* kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.\n* kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.\n* kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.\n* kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.\n* kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.\n* kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "nodeCount", "nodeType" ] }, "aws:finspace/KxClusterCode:KxClusterCode": { "properties": { "s3Bucket": { "type": "string", "description": "Unique name for the S3 bucket.\n" }, "s3Key": { "type": "string", "description": "Full S3 path (excluding bucket) to the .zip file that contains the code to be loaded onto the cluster when it’s started.\n" }, "s3ObjectVersion": { "type": "string", "description": "Version of an S3 Object.\n" } }, "type": "object", "required": [ "s3Bucket", "s3Key" ] }, "aws:finspace/KxClusterDatabase:KxClusterDatabase": { "properties": { "cacheConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:finspace/KxClusterDatabaseCacheConfiguration:KxClusterDatabaseCacheConfiguration" }, "description": "Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.\n" }, "changesetId": { "type": "string", "description": "A unique identifier of the changeset that is associated with the cluster.\n" }, "databaseName": { "type": "string", "description": "Name of the KX database.\n", "willReplaceOnChanges": true }, "dataviewName": { "type": "string", "description": "The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use `lifecycle` `ignore_changes` for database to prevent any undesirable behaviors.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName" ] }, "aws:finspace/KxClusterDatabaseCacheConfiguration:KxClusterDatabaseCacheConfiguration": { "properties": { "cacheType": { "type": "string", "description": "Type of disk cache.\n", "willReplaceOnChanges": true }, "dbPaths": { "type": "array", "items": { "type": "string" }, "description": "Paths within the database to cache.\n" } }, "type": "object", "required": [ "cacheType" ] }, "aws:finspace/KxClusterSavedownStorageConfiguration:KxClusterSavedownStorageConfiguration": { "properties": { "size": { "type": "integer", "description": "Size of temporary storage in gigabytes. Must be between 10 and 16000.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Type of writeable storage space for temporarily storing your savedown data. The valid values are:\n* SDS01 - This type represents 3000 IOPS and io2 ebs volume type.\n", "willReplaceOnChanges": true }, "volumeName": { "type": "string", "description": "The name of the kdb volume that you want to use as writeable save-down storage for clusters.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:finspace/KxClusterScalingGroupConfiguration:KxClusterScalingGroupConfiguration": { "properties": { "cpu": { "type": "number", "description": "The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.\n", "willReplaceOnChanges": true }, "memoryLimit": { "type": "integer", "description": "An optional hard limit on the amount of memory a kdb cluster can use.\n", "willReplaceOnChanges": true }, "memoryReservation": { "type": "integer", "description": "A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.\n", "willReplaceOnChanges": true }, "nodeCount": { "type": "integer", "description": "The number of kdb cluster nodes.\n", "willReplaceOnChanges": true }, "scalingGroupName": { "type": "string", "description": "A unique identifier for the kdb scaling group.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "memoryReservation", "nodeCount", "scalingGroupName" ] }, "aws:finspace/KxClusterTickerplantLogConfiguration:KxClusterTickerplantLogConfiguration": { "properties": { "tickerplantLogVolumes": { "type": "array", "items": { "type": "string" }, "willReplaceOnChanges": true } }, "type": "object", "required": [ "tickerplantLogVolumes" ] }, "aws:finspace/KxClusterVpcConfiguration:KxClusterVpcConfiguration": { "properties": { "ipAddressType": { "type": "string", "description": "IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.\n* `subnet_ids `- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "Identifier of the VPC endpoint\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "ipAddressType", "securityGroupIds", "subnetIds", "vpcId" ] }, "aws:finspace/KxDataviewSegmentConfiguration:KxDataviewSegmentConfiguration": { "properties": { "dbPaths": { "type": "array", "items": { "type": "string" }, "description": "The database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume.\n" }, "onDemand": { "type": "boolean", "description": "Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is **True**, dataviews perform minimal loading of files on the filesystem as needed. When it is set to **False**, everything is cached. The default value is **False**.\n", "willReplaceOnChanges": true }, "volumeName": { "type": "string", "description": "The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.\n" } }, "type": "object", "required": [ "dbPaths", "volumeName" ] }, "aws:finspace/KxEnvironmentCustomDnsConfiguration:KxEnvironmentCustomDnsConfiguration": { "properties": { "customDnsServerIp": { "type": "string", "description": "IP address of the DNS server.\n" }, "customDnsServerName": { "type": "string", "description": "Name of the DNS server.\n" } }, "type": "object", "required": [ "customDnsServerIp", "customDnsServerName" ] }, "aws:finspace/KxEnvironmentTransitGatewayConfiguration:KxEnvironmentTransitGatewayConfiguration": { "properties": { "attachmentNetworkAclConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfiguration:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfiguration" }, "description": "Rules that define how you manage outbound traffic from kdb network to your internal network. Defined below.\n" }, "routableCidrSpace": { "type": "string", "description": "Routing CIDR on behalf of KX environment. It could be any “/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer’s transit gateway routing table so that the traffics could be routed to KX network.\n" }, "transitGatewayId": { "type": "string", "description": "Identifier of the transit gateway created by the customer to connect outbound traffics from KX network to your internal network.\n" } }, "type": "object", "required": [ "routableCidrSpace", "transitGatewayId" ] }, "aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfiguration:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfiguration": { "properties": { "cidrBlock": { "type": "string", "description": "The IPv4 network range to allow or deny, in CIDR notation. The specified CIDR block is modified to its canonical form. For example, `100.68.0.18/18` will be converted to `100.68.0.0/18`.\n" }, "icmpTypeCode": { "$ref": "#/types/aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCode:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCode", "description": "Defines the ICMP protocol that consists of the ICMP type and code. Defined below.\n" }, "portRange": { "$ref": "#/types/aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRange:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRange", "description": "Range of ports the rule applies to. Defined below.\n" }, "protocol": { "type": "string", "description": "Protocol number. A value of `1` means all the protocols.\n" }, "ruleAction": { "type": "string", "description": "Indicates whether to `allow` or `deny` the traffic that matches the rule.\n" }, "ruleNumber": { "type": "integer", "description": "Rule number for the entry. All the network ACL entries are processed in ascending order by rule number.\n" } }, "type": "object", "required": [ "cidrBlock", "protocol", "ruleAction", "ruleNumber" ] }, "aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCode:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCode": { "properties": { "code": { "type": "integer", "description": "ICMP code. A value of `-1` means all codes for the specified ICMP type.\n" }, "type": { "type": "integer", "description": "ICMP type. A value of `-1` means all types.\n" } }, "type": "object", "required": [ "code", "type" ] }, "aws:finspace/KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRange:KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRange": { "properties": { "from": { "type": "integer", "description": "First port in the range.\n" }, "to": { "type": "integer", "description": "Last port in the range.\n" } }, "type": "object", "required": [ "from", "to" ] }, "aws:finspace/KxVolumeAttachedCluster:KxVolumeAttachedCluster": { "properties": { "clusterName": { "type": "string", "willReplaceOnChanges": true }, "clusterStatus": { "type": "string", "willReplaceOnChanges": true }, "clusterType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "clusterName", "clusterStatus", "clusterType" ] }, "aws:finspace/KxVolumeNas1Configuration:KxVolumeNas1Configuration": { "properties": { "size": { "type": "integer", "description": "The size of the network attached storage.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of the network attached storage.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "size", "type" ] }, "aws:fis/ExperimentTemplateAction:ExperimentTemplateAction": { "properties": { "actionId": { "type": "string", "description": "ID of the action. To find out what actions are supported see [AWS FIS actions reference](https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html).\n" }, "description": { "type": "string", "description": "Description of the action.\n" }, "name": { "type": "string", "description": "Friendly name of the action.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:fis/ExperimentTemplateActionParameter:ExperimentTemplateActionParameter" }, "description": "Parameter(s) for the action, if applicable. See below.\n" }, "startAfters": { "type": "array", "items": { "type": "string" }, "description": "Set of action names that must complete before this action can be executed.\n" }, "target": { "$ref": "#/types/aws:fis/ExperimentTemplateActionTarget:ExperimentTemplateActionTarget", "description": "Action's target, if applicable. See below.\n" } }, "type": "object", "required": [ "actionId", "name" ] }, "aws:fis/ExperimentTemplateActionParameter:ExperimentTemplateActionParameter": { "properties": { "key": { "type": "string", "description": "Parameter name.\n" }, "value": { "type": "string", "description": "Parameter value.\n\nFor a list of parameters supported by each action, see [AWS FIS actions reference](https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html).\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:fis/ExperimentTemplateActionTarget:ExperimentTemplateActionTarget": { "properties": { "key": { "type": "string", "description": "Target type. Valid values are `AutoScalingGroups` (EC2 Auto Scaling groups), `Buckets` (S3 Buckets), `Cluster` (EKS Cluster), `Clusters` (ECS Clusters), `DBInstances` (RDS DB Instances), `Instances` (EC2 Instances), `Nodegroups` (EKS Node groups), `Pods` (EKS Pods), `ReplicationGroups`(ElastiCache Redis Replication Groups), `Roles` (IAM Roles), `SpotInstances` (EC2 Spot Instances), `Subnets` (VPC Subnets), `Tables` (DynamoDB encrypted global tables), `Tasks` (ECS Tasks), `TransitGateways` (Transit gateways), `Volumes` (EBS Volumes). See the [documentation](https://docs.aws.amazon.com/fis/latest/userguide/actions.html#action-targets) for more details.\n" }, "value": { "type": "string", "description": "Target name, referencing a corresponding target.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:fis/ExperimentTemplateExperimentOptions:ExperimentTemplateExperimentOptions": { "properties": { "accountTargeting": { "type": "string", "description": "Specifies the account targeting setting for experiment options. Supports `single-account` and `multi-account`.\n" }, "emptyTargetResolutionMode": { "type": "string", "description": "Specifies the empty target resolution mode for experiment options. Supports `fail` and `skip`.\n" } }, "type": "object" }, "aws:fis/ExperimentTemplateLogConfiguration:ExperimentTemplateLogConfiguration": { "properties": { "cloudwatchLogsConfiguration": { "$ref": "#/types/aws:fis/ExperimentTemplateLogConfigurationCloudwatchLogsConfiguration:ExperimentTemplateLogConfigurationCloudwatchLogsConfiguration", "description": "The configuration for experiment logging to Amazon CloudWatch Logs. See below.\n" }, "logSchemaVersion": { "type": "integer", "description": "The schema version. See [documentation](https://docs.aws.amazon.com/fis/latest/userguide/monitoring-logging.html#experiment-log-schema) for the list of schema versions.\n" }, "s3Configuration": { "$ref": "#/types/aws:fis/ExperimentTemplateLogConfigurationS3Configuration:ExperimentTemplateLogConfigurationS3Configuration", "description": "The configuration for experiment logging to Amazon S3. See below.\n" } }, "type": "object", "required": [ "logSchemaVersion" ] }, "aws:fis/ExperimentTemplateLogConfigurationCloudwatchLogsConfiguration:ExperimentTemplateLogConfigurationCloudwatchLogsConfiguration": { "properties": { "logGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.\n" } }, "type": "object", "required": [ "logGroupArn" ] }, "aws:fis/ExperimentTemplateLogConfigurationS3Configuration:ExperimentTemplateLogConfigurationS3Configuration": { "properties": { "bucketName": { "type": "string", "description": "The name of the destination bucket.\n" }, "prefix": { "type": "string", "description": "The bucket prefix.\n" } }, "type": "object", "required": [ "bucketName" ] }, "aws:fis/ExperimentTemplateStopCondition:ExperimentTemplateStopCondition": { "properties": { "source": { "type": "string", "description": "Source of the condition. One of `none`, `aws:cloudwatch:alarm`.\n" }, "value": { "type": "string", "description": "ARN of the CloudWatch alarm. Required if the source is a CloudWatch alarm.\n" } }, "type": "object", "required": [ "source" ] }, "aws:fis/ExperimentTemplateTarget:ExperimentTemplateTarget": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:fis/ExperimentTemplateTargetFilter:ExperimentTemplateTargetFilter" }, "description": "Filter(s) for the target. Filters can be used to select resources based on specific attributes returned by the respective describe action of the resource type. For more information, see [Targets for AWS FIS](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters). See below.\n" }, "name": { "type": "string", "description": "Friendly name given to the target.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The resource type parameters.\n\n\u003e **NOTE:** The `target` configuration block requires either `resource_arns` or `resource_tag`.\n" }, "resourceArns": { "type": "array", "items": { "type": "string" }, "description": "Set of ARNs of the resources to target with an action. Conflicts with `resource_tag`.\n" }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws:fis/ExperimentTemplateTargetResourceTag:ExperimentTemplateTargetResourceTag" }, "description": "Tag(s) the resources need to have to be considered a valid target for an action. Conflicts with `resource_arns`. See below.\n" }, "resourceType": { "type": "string", "description": "AWS resource type. The resource type must be supported for the specified action. To find out what resource types are supported, see [Targets for AWS FIS](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#resource-types).\n" }, "selectionMode": { "type": "string", "description": "Scopes the identified resources. Valid values are `ALL` (all identified resources), `COUNT(n)` (randomly select `n` of the identified resources), `PERCENT(n)` (randomly select `n` percent of the identified resources).\n" } }, "type": "object", "required": [ "name", "resourceType", "selectionMode" ] }, "aws:fis/ExperimentTemplateTargetFilter:ExperimentTemplateTargetFilter": { "properties": { "path": { "type": "string", "description": "Attribute path for the filter.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of attribute values for the filter.\n\n\u003e **NOTE:** Values specified in a `filter` are joined with an `OR` clause, while values across multiple `filter` blocks are joined with an `AND` clause. For more information, see [Targets for AWS FIS](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters).\n" } }, "type": "object", "required": [ "path", "values" ] }, "aws:fis/ExperimentTemplateTargetResourceTag:ExperimentTemplateTargetResourceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:fms/PolicyExcludeMap:PolicyExcludeMap": { "properties": { "accounts": { "type": "array", "items": { "type": "string" }, "description": "A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.\n" }, "orgunits": { "type": "array", "items": { "type": "string" }, "description": "A list of IDs of the AWS Organizational Units that you want to include for this AWS FMS Policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.\n\nYou can specify inclusions or exclusions, but not both. If you specify an `include_map`, AWS Firewall Manager applies the policy to all accounts specified by the `include_map`, and does not evaluate any `exclude_map` specifications. If you do not specify an `include_map`, then Firewall Manager applies the policy to all accounts except for those specified by the `exclude_map`.\n" } }, "type": "object" }, "aws:fms/PolicyIncludeMap:PolicyIncludeMap": { "properties": { "accounts": { "type": "array", "items": { "type": "string" }, "description": "A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.\n" }, "orgunits": { "type": "array", "items": { "type": "string" }, "description": "A list of IDs of the AWS Organizational Units that you want to include for this AWS FMS Policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.\n\nYou can specify inclusions or exclusions, but not both. If you specify an `include_map`, AWS Firewall Manager applies the policy to all accounts specified by the `include_map`, and does not evaluate any `exclude_map` specifications. If you do not specify an `include_map`, then Firewall Manager applies the policy to all accounts except for those specified by the `exclude_map`.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyData:PolicySecurityServicePolicyData": { "properties": { "managedServiceData": { "type": "string", "description": "Details about the service that are specific to the service type, in JSON format. For service type `SHIELD_ADVANCED`, this is an empty string. Examples depending on `type` can be found in the [AWS Firewall Manager SecurityServicePolicyData API Reference](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_SecurityServicePolicyData.html).\n" }, "policyOption": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOption:PolicySecurityServicePolicyDataPolicyOption", "description": "Contains the Network Firewall firewall policy options to configure a centralized deployment model. See the `policy_option` block.\n" }, "type": { "type": "string", "description": "An integer value containing ICMP type.\n" } }, "type": "object", "required": [ "type" ] }, "aws:fms/PolicySecurityServicePolicyDataPolicyOption:PolicySecurityServicePolicyDataPolicyOption": { "properties": { "networkAclCommonPolicy": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicy:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicy", "description": "Defines NACL rules across accounts in their AWS Organization. See the `network_acl_common_policy` block.\n" }, "networkFirewallPolicy": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkFirewallPolicy:PolicySecurityServicePolicyDataPolicyOptionNetworkFirewallPolicy", "description": "Defines the deployment model to use for the firewall policy. See the `network_firewall_policy` block.\n" }, "thirdPartyFirewallPolicy": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionThirdPartyFirewallPolicy:PolicySecurityServicePolicyDataPolicyOptionThirdPartyFirewallPolicy" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicy:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicy": { "properties": { "networkAclEntrySet": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySet:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySet", "description": "Defines NACL entries for Network ACL policy. See the `network_acl_entry_set` block.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySet:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySet": { "properties": { "firstEntries": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntry:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntry" }, "description": "The rules that you want to run first in the Firewall Manager managed network ACLs. Firewall manager creates entries with ID value between 1 and 5000. See the `first_entry` block.\n" }, "forceRemediateForFirstEntries": { "type": "boolean", "description": "A boolean value, if true Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If false Firewall Manager marks the network ACL as noncompliant and does not try to remediate.\n" }, "forceRemediateForLastEntries": { "type": "boolean", "description": "A boolean value, if true Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If false Firewall Manager marks the network ACL as noncompliant and does not try to remediate.\n" }, "lastEntries": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntry:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntry" }, "description": "The rules that you want to run last in the Firewall Manager managed network ACLs. Firewall manager creates entries with ID value between 32000 and 32766. See the `last_entry` block.\n" } }, "type": "object", "required": [ "forceRemediateForFirstEntries", "forceRemediateForLastEntries" ] }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntry:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntry": { "properties": { "cidrBlock": { "type": "string", "description": "A string value containing the IPv4 network range to allow or deny, in CIDR notation.\n" }, "egress": { "type": "boolean", "description": "A boolean value, if true Firewall Manager creates egress rule. If false Firewall Manager creates ingress rule.\n" }, "icmpTypeCodes": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryIcmpTypeCode:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryIcmpTypeCode" }, "description": "A configuration block for ICMP protocol: The ICMP type and code. See the `icmp_type_code` block.\n" }, "ipv6CidrBlock": { "type": "string", "description": "A string value containing the IPv6 network range to allow or deny, in CIDR notation.\n" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryPortRange:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryPortRange" }, "description": "A configuration block for PortRange. See the `port_range` block.\n" }, "protocol": { "type": "string", "description": "The protocol number. A value of \"-1\" means all protocols.\n" }, "ruleAction": { "type": "string", "description": "A string value that indicates whether to allow or deny the traffic that matches the rule. Valid values: `allow`, `deny`.\n" } }, "type": "object", "required": [ "egress", "protocol", "ruleAction" ] }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryIcmpTypeCode:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryIcmpTypeCode": { "properties": { "code": { "type": "integer", "description": "An integer value containing ICMP code.\n" }, "type": { "type": "integer", "description": "An integer value containing ICMP type.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryPortRange:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetFirstEntryPortRange": { "properties": { "from": { "type": "integer", "description": "The beginning port number of the range.\n" }, "to": { "type": "integer", "description": "The ending port number of the range.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntry:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntry": { "properties": { "cidrBlock": { "type": "string", "description": "A string value containing the IPv4 network range to allow or deny, in CIDR notation.\n" }, "egress": { "type": "boolean", "description": "A boolean value, if true Firewall Manager creates egress rule. If false Firewall Manager creates ingress rule.\n" }, "icmpTypeCodes": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryIcmpTypeCode:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryIcmpTypeCode" }, "description": "A configuration block for ICMP protocol: The ICMP type and code. See the `icmp_type_code` block.\n" }, "ipv6CidrBlock": { "type": "string", "description": "A string value containing the IPv6 network range to allow or deny, in CIDR notation.\n" }, "portRanges": { "type": "array", "items": { "$ref": "#/types/aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryPortRange:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryPortRange" }, "description": "A configuration block for PortRange. See the `port_range` block.\n" }, "protocol": { "type": "string", "description": "The protocol number. A value of \"-1\" means all protocols.\n" }, "ruleAction": { "type": "string", "description": "A string value that indicates whether to allow or deny the traffic that matches the rule. Valid values: `allow`, `deny`.\n" } }, "type": "object", "required": [ "egress", "protocol", "ruleAction" ] }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryIcmpTypeCode:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryIcmpTypeCode": { "properties": { "code": { "type": "integer", "description": "An integer value containing ICMP code.\n" }, "type": { "type": "integer", "description": "An integer value containing ICMP type.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryPortRange:PolicySecurityServicePolicyDataPolicyOptionNetworkAclCommonPolicyNetworkAclEntrySetLastEntryPortRange": { "properties": { "from": { "type": "integer", "description": "The beginning port number of the range.\n" }, "to": { "type": "integer", "description": "The ending port number of the range.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionNetworkFirewallPolicy:PolicySecurityServicePolicyDataPolicyOptionNetworkFirewallPolicy": { "properties": { "firewallDeploymentModel": { "type": "string", "description": "Defines the deployment model to use for the third-party firewall policy. Valid values are `CENTRALIZED` and `DISTRIBUTED`.\n" } }, "type": "object" }, "aws:fms/PolicySecurityServicePolicyDataPolicyOptionThirdPartyFirewallPolicy:PolicySecurityServicePolicyDataPolicyOptionThirdPartyFirewallPolicy": { "properties": { "firewallDeploymentModel": { "type": "string", "description": "Defines the deployment model to use for the third-party firewall policy. Valid values are `CENTRALIZED` and `DISTRIBUTED`.\n" } }, "type": "object" }, "aws:fms/ResourceSetResourceSet:ResourceSetResourceSet": { "properties": { "description": { "type": "string", "description": "Description of the resource set.\n" }, "id": { "type": "string", "description": "Unique identifier for the resource set. It's returned in the responses to create and list commands. You provide it to operations like update and delete.\n" }, "lastUpdateTime": { "type": "string", "description": "Last time that the reosurce set was changed.\n" }, "name": { "type": "string", "description": "Descriptive name of the resource set. You can't change the name of a resource set after you create it.\n" }, "resourceSetStatus": { "type": "string", "description": "Indicates whether the resource set is in or out of the admin's Region scope. Valid values are `ACTIVE` (Admin can manage and delete the resource set) or `OUT_OF_ADMIN_SCOPE` (Admin can view the resource set, but they can't edit or delete the resource set.)\n" }, "resourceTypeLists": { "type": "array", "items": { "type": "string" }, "description": "Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.\n" }, "updateToken": { "type": "string" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "id", "lastUpdateTime", "name", "resourceSetStatus", "updateToken" ] } } }, "aws:fms/ResourceSetTimeouts:ResourceSetTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:fsx/DataRepositoryAssociationS3:DataRepositoryAssociationS3": { "properties": { "autoExportPolicy": { "$ref": "#/types/aws:fsx/DataRepositoryAssociationS3AutoExportPolicy:DataRepositoryAssociationS3AutoExportPolicy", "description": "Specifies the type of updated objects that will be automatically exported from your file system to the linked S3 bucket. See the `events` configuration block.\n" }, "autoImportPolicy": { "$ref": "#/types/aws:fsx/DataRepositoryAssociationS3AutoImportPolicy:DataRepositoryAssociationS3AutoImportPolicy", "description": "Specifies the type of updated objects that will be automatically imported from the linked S3 bucket to your file system. See the `events` configuration block.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoExportPolicy", "autoImportPolicy" ] } } }, "aws:fsx/DataRepositoryAssociationS3AutoExportPolicy:DataRepositoryAssociationS3AutoExportPolicy": { "properties": { "events": { "type": "array", "items": { "type": "string" }, "description": "A list of file event types to automatically export to your linked S3 bucket or import from the linked S3 bucket. Valid values are `NEW`, `CHANGED`, `DELETED`. Max of 3.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "events" ] } } }, "aws:fsx/DataRepositoryAssociationS3AutoImportPolicy:DataRepositoryAssociationS3AutoImportPolicy": { "properties": { "events": { "type": "array", "items": { "type": "string" }, "description": "A list of file event types to automatically export to your linked S3 bucket or import from the linked S3 bucket. Valid values are `NEW`, `CHANGED`, `DELETED`. Max of 3.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "events" ] } } }, "aws:fsx/FileCacheDataRepositoryAssociation:FileCacheDataRepositoryAssociation": { "properties": { "associationId": { "type": "string" }, "dataRepositoryPath": { "type": "string", "description": "The path to the S3 or NFS data repository that links to the cache.\n" }, "dataRepositorySubdirectories": { "type": "array", "items": { "type": "string" }, "description": "A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.\n" }, "fileCacheId": { "type": "string", "description": "The system-generated, unique ID of the cache.\n" }, "fileCachePath": { "type": "string", "description": "A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.\n" }, "fileSystemId": { "type": "string" }, "fileSystemPath": { "type": "string" }, "importedFileChunkSize": { "type": "integer" }, "nfs": { "type": "array", "items": { "$ref": "#/types/aws:fsx/FileCacheDataRepositoryAssociationNf:FileCacheDataRepositoryAssociationNf" }, "description": "(Optional) See the `nfs` configuration block.\n" }, "resourceArn": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of tags to assign to the file cache. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n" } }, "type": "object", "required": [ "dataRepositoryPath", "fileCachePath" ], "language": { "nodejs": { "requiredOutputs": [ "associationId", "dataRepositoryPath", "fileCacheId", "fileCachePath", "fileSystemId", "fileSystemPath", "importedFileChunkSize", "resourceArn", "tags" ] } } }, "aws:fsx/FileCacheDataRepositoryAssociationNf:FileCacheDataRepositoryAssociationNf": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.\n" }, "version": { "type": "string", "description": "The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is `NFS3`.\n" } }, "type": "object", "required": [ "version" ] }, "aws:fsx/FileCacheLustreConfiguration:FileCacheLustreConfiguration": { "properties": { "deploymentType": { "type": "string", "description": "Specifies the cache deployment type. The only supported value is `CACHE_1`.\n", "willReplaceOnChanges": true }, "logConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:fsx/FileCacheLustreConfigurationLogConfiguration:FileCacheLustreConfigurationLogConfiguration" } }, "metadataConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:fsx/FileCacheLustreConfigurationMetadataConfiguration:FileCacheLustreConfigurationMetadataConfiguration" }, "description": "The configuration for a Lustre MDT (Metadata Target) storage volume. See the `metadata_configuration` block.\n", "willReplaceOnChanges": true }, "mountName": { "type": "string" }, "perUnitStorageThroughput": { "type": "integer", "description": "Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is `1000`.\n", "willReplaceOnChanges": true }, "weeklyMaintenanceStartTime": { "type": "string", "description": "A recurring weekly time, in the format `D:HH:MM`. `D` is the day of the week, for which `1` represents Monday and `7` represents Sunday. `HH` is the zero-padded hour of the day (0-23), and `MM` is the zero-padded minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the [ISO week date](https://en.wikipedia.org/wiki/ISO_week_date) for more information.\n" } }, "type": "object", "required": [ "deploymentType", "metadataConfigurations", "perUnitStorageThroughput" ], "language": { "nodejs": { "requiredOutputs": [ "deploymentType", "logConfigurations", "metadataConfigurations", "mountName", "perUnitStorageThroughput" ] } } }, "aws:fsx/FileCacheLustreConfigurationLogConfiguration:FileCacheLustreConfigurationLogConfiguration": { "properties": { "destination": { "type": "string" }, "level": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destination", "level" ] } } }, "aws:fsx/FileCacheLustreConfigurationMetadataConfiguration:FileCacheLustreConfigurationMetadataConfiguration": { "properties": { "storageCapacity": { "type": "integer", "description": "The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is `2400` GiB.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "storageCapacity" ] }, "aws:fsx/LustreFileSystemLogConfiguration:LustreFileSystemLogConfiguration": { "properties": { "destination": { "type": "string", "description": "The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the `/aws/fsx` prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs `/aws/fsx/lustre` log group.\n" }, "level": { "type": "string", "description": "Sets which data repository events are logged by Amazon FSx. Valid values are `WARN_ONLY`, `FAILURE_ONLY`, `ERROR_ONLY`, `WARN_ERROR` and `DISABLED`. Default value is `DISABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destination" ] } } }, "aws:fsx/LustreFileSystemMetadataConfiguration:LustreFileSystemMetadataConfiguration": { "properties": { "iops": { "type": "integer", "description": "Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to `USER_PROVISIONED`. Valid Values are `1500`,`3000`,`6000` and `12000` through `192000` in increments of `12000`.\n" }, "mode": { "type": "string", "description": "Mode for the metadata configuration of the file system. Valid values are `AUTOMATIC`, and `USER_PROVISIONED`.\n\n!\u003e **WARNING:** Updating the value of `iops` from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops", "mode" ] } } }, "aws:fsx/LustreFileSystemRootSquashConfiguration:LustreFileSystemRootSquashConfiguration": { "properties": { "noSquashNids": { "type": "array", "items": { "type": "string" }, "description": "When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).\n" }, "rootSquash": { "type": "string", "description": "You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.\n" } }, "type": "object" }, "aws:fsx/OntapFileSystemDiskIopsConfiguration:OntapFileSystemDiskIopsConfiguration": { "properties": { "iops": { "type": "integer", "description": "The total number of SSD IOPS provisioned for the file system.\n" }, "mode": { "type": "string", "description": "Specifies whether the number of IOPS for the file system is using the system. Valid values are `AUTOMATIC` and `USER_PROVISIONED`. Default value is `AUTOMATIC`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops" ] } } }, "aws:fsx/OntapFileSystemEndpoint:OntapFileSystemEndpoint": { "properties": { "interclusters": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapFileSystemEndpointIntercluster:OntapFileSystemEndpointIntercluster" }, "description": "An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.\n" }, "managements": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapFileSystemEndpointManagement:OntapFileSystemEndpointManagement" }, "description": "An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "interclusters", "managements" ] } } }, "aws:fsx/OntapFileSystemEndpointIntercluster:OntapFileSystemEndpointIntercluster": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the file system endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapFileSystemEndpointManagement:OntapFileSystemEndpointManagement": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the file system endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapStorageVirtualMachineActiveDirectoryConfiguration:OntapStorageVirtualMachineActiveDirectoryConfiguration": { "properties": { "netbiosName": { "type": "string", "description": "The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.\n" }, "selfManagedActiveDirectoryConfiguration": { "$ref": "#/types/aws:fsx/OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration:OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration" } }, "type": "object" }, "aws:fsx/OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration:OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.\n" }, "domainName": { "type": "string", "description": "The fully qualified domain name of the self-managed AD directory. For example, `corp.example.com`.\n" }, "fileSystemAdministratorsGroup": { "type": "string", "description": "The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to `Domain Admins`.\n" }, "organizationalUnitDistinguishedName": { "type": "string", "description": "The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, `OU=FSx,DC=yourdomain,DC=corp,DC=com`. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253).\n" }, "password": { "type": "string", "description": "The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.\n", "secret": true }, "username": { "type": "string", "description": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.\n" } }, "type": "object", "required": [ "dnsIps", "domainName", "password", "username" ] }, "aws:fsx/OntapStorageVirtualMachineEndpoint:OntapStorageVirtualMachineEndpoint": { "properties": { "iscsis": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapStorageVirtualMachineEndpointIscsi:OntapStorageVirtualMachineEndpointIscsi" }, "description": "An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.\n" }, "managements": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapStorageVirtualMachineEndpointManagement:OntapStorageVirtualMachineEndpointManagement" }, "description": "An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.\n" }, "nfs": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapStorageVirtualMachineEndpointNf:OntapStorageVirtualMachineEndpointNf" }, "description": "An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.\n" }, "smbs": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OntapStorageVirtualMachineEndpointSmb:OntapStorageVirtualMachineEndpointSmb" }, "description": "An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iscsis", "managements", "nfs", "smbs" ] } } }, "aws:fsx/OntapStorageVirtualMachineEndpointIscsi:OntapStorageVirtualMachineEndpointIscsi": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the storage virtual machine endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapStorageVirtualMachineEndpointManagement:OntapStorageVirtualMachineEndpointManagement": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the storage virtual machine endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapStorageVirtualMachineEndpointNf:OntapStorageVirtualMachineEndpointNf": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the storage virtual machine endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapStorageVirtualMachineEndpointSmb:OntapStorageVirtualMachineEndpointSmb": { "properties": { "dnsName": { "type": "string", "description": "The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "IP addresses of the storage virtual machine endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsName", "ipAddresses" ] } } }, "aws:fsx/OntapVolumeAggregateConfiguration:OntapVolumeAggregateConfiguration": { "properties": { "aggregates": { "type": "array", "items": { "type": "string" }, "description": "Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.\n", "willReplaceOnChanges": true }, "constituentsPerAggregate": { "type": "integer", "description": "Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is `8`.\n", "willReplaceOnChanges": true }, "totalConstituents": { "type": "integer", "description": "The total amount of constituents for a `FLEXGROUP` volume. This would equal constituents_per_aggregate x aggregates.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aggregates", "constituentsPerAggregate", "totalConstituents" ] } } }, "aws:fsx/OntapVolumeSnaplockConfiguration:OntapVolumeSnaplockConfiguration": { "properties": { "auditLogVolume": { "type": "boolean", "description": "Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is `false`.\n" }, "autocommitPeriod": { "$ref": "#/types/aws:fsx/OntapVolumeSnaplockConfigurationAutocommitPeriod:OntapVolumeSnaplockConfigurationAutocommitPeriod", "description": "The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See `autocommit_period` Block for details.\n" }, "privilegedDelete": { "type": "string", "description": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: `DISABLED`, `ENABLED`, `PERMANENTLY_DISABLED`. The default value is `DISABLED`.\n" }, "retentionPeriod": { "$ref": "#/types/aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriod:OntapVolumeSnaplockConfigurationRetentionPeriod", "description": "The retention period of an FSx for ONTAP SnapLock volume. See `retention_period` Block for details.\n" }, "snaplockType": { "type": "string", "description": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: `COMPLIANCE`, `ENTERPRISE`.\n", "willReplaceOnChanges": true }, "volumeAppendModeEnabled": { "type": "boolean", "description": "Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is `false`.\n" } }, "type": "object", "required": [ "snaplockType" ], "language": { "nodejs": { "requiredOutputs": [ "autocommitPeriod", "retentionPeriod", "snaplockType" ] } } }, "aws:fsx/OntapVolumeSnaplockConfigurationAutocommitPeriod:OntapVolumeSnaplockConfigurationAutocommitPeriod": { "properties": { "type": { "type": "string", "description": "The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to `NONE` disables autocommit. Valid values: `MINUTES`, `HOURS`, `DAYS`, `MONTHS`, `YEARS`, `NONE`.\n" }, "value": { "type": "integer", "description": "The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriod:OntapVolumeSnaplockConfigurationRetentionPeriod": { "properties": { "defaultRetention": { "$ref": "#/types/aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention:OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention", "description": "The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See `default_retention` Block for details.\n" }, "maximumRetention": { "$ref": "#/types/aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention:OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention", "description": "The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See `maximum_retention` Block for details.\n" }, "minimumRetention": { "$ref": "#/types/aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention:OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention", "description": "The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See `minimum_retention` Block for details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "defaultRetention", "maximumRetention", "minimumRetention" ] } } }, "aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention:OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention": { "properties": { "type": { "type": "string", "description": "The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to `INFINITE`, the files are retained forever. If you set it to `UNSPECIFIED`, the files are retained until you set an explicit retention period. Valid values: `SECONDS`, `MINUTES`, `HOURS`, `DAYS`, `MONTHS`, `YEARS`, `INFINITE`, `UNSPECIFIED`.\n" }, "value": { "type": "integer", "description": "The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention:OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention": { "properties": { "type": { "type": "string", "description": "The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to `INFINITE`, the files are retained forever. If you set it to `UNSPECIFIED`, the files are retained until you set an explicit retention period. Valid values: `SECONDS`, `MINUTES`, `HOURS`, `DAYS`, `MONTHS`, `YEARS`, `INFINITE`, `UNSPECIFIED`.\n" }, "value": { "type": "integer", "description": "The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:fsx/OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention:OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention": { "properties": { "type": { "type": "string", "description": "The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to `INFINITE`, the files are retained forever. If you set it to `UNSPECIFIED`, the files are retained until you set an explicit retention period. Valid values: `SECONDS`, `MINUTES`, `HOURS`, `DAYS`, `MONTHS`, `YEARS`, `INFINITE`, `UNSPECIFIED`.\n" }, "value": { "type": "integer", "description": "The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:fsx/OntapVolumeTieringPolicy:OntapVolumeTieringPolicy": { "properties": { "coolingPeriod": { "type": "integer", "description": "Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool. Used with `AUTO` and `SNAPSHOT_ONLY` tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for `AUTO` and 2 days for `SNAPSHOT_ONLY`.\n" }, "name": { "type": "string", "description": "Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are `SNAPSHOT_ONLY`, `AUTO`, `ALL`, `NONE`. Default value is `SNAPSHOT_ONLY`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "coolingPeriod", "name" ] } } }, "aws:fsx/OpenZfsFileSystemDiskIopsConfiguration:OpenZfsFileSystemDiskIopsConfiguration": { "properties": { "iops": { "type": "integer", "description": "The total number of SSD IOPS provisioned for the file system.\n" }, "mode": { "type": "string", "description": "Specifies whether the number of IOPS for the file system is using the system. Valid values are `AUTOMATIC` and `USER_PROVISIONED`. Default value is `AUTOMATIC`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops" ] } } }, "aws:fsx/OpenZfsFileSystemRootVolumeConfiguration:OpenZfsFileSystemRootVolumeConfiguration": { "properties": { "copyTagsToSnapshots": { "type": "boolean", "description": "A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.\n", "willReplaceOnChanges": true }, "dataCompressionType": { "type": "string", "description": "Method used to compress the data on the volume. Valid values are `LZ4`, `NONE` or `ZSTD`. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.\n" }, "nfsExports": { "$ref": "#/types/aws:fsx/OpenZfsFileSystemRootVolumeConfigurationNfsExports:OpenZfsFileSystemRootVolumeConfigurationNfsExports", "description": "NFS export configuration for the root volume. Exactly 1 item. See `nfs_exports` Block for details.\n" }, "readOnly": { "type": "boolean", "description": "specifies whether the volume is read-only. Default is false.\n" }, "recordSizeKib": { "type": "integer", "description": "Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, or `1024` KiB. The default is `128` KiB.\n" }, "userAndGroupQuotas": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota:OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota" }, "description": "Specify how much storage users or groups can use on the volume. Maximum of 100 items. See `user_and_group_quotas` Block for details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "readOnly", "userAndGroupQuotas" ] } } }, "aws:fsx/OpenZfsFileSystemRootVolumeConfigurationNfsExports:OpenZfsFileSystemRootVolumeConfigurationNfsExports": { "properties": { "clientConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration:OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration" }, "description": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See `client_configurations` Block for details.\n" } }, "type": "object", "required": [ "clientConfigurations" ] }, "aws:fsx/OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration:OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration": { "properties": { "clients": { "type": "string", "description": "A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24. By default, Amazon FSx uses the wildcard character when specifying the client.\n" }, "options": { "type": "array", "items": { "type": "string" }, "description": "The options to use when mounting the file system. Maximum of 20 items. See the [Linix NFS exports man page](https://linux.die.net/man/5/exports) for more information. `crossmount` and `sync` are used by default.\n" } }, "type": "object", "required": [ "clients", "options" ] }, "aws:fsx/OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota:OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota": { "properties": { "id": { "type": "integer", "description": "The ID of the user or group. Valid values between `0` and `2147483647`\n" }, "storageCapacityQuotaGib": { "type": "integer", "description": "The amount of storage that the user or group can use in gibibytes (GiB). Valid values between `0` and `2147483647`\n" }, "type": { "type": "string", "description": "A value that specifies whether the quota applies to a user or group. Valid values are `USER` or `GROUP`.\n" } }, "type": "object", "required": [ "id", "storageCapacityQuotaGib", "type" ] }, "aws:fsx/OpenZfsVolumeNfsExports:OpenZfsVolumeNfsExports": { "properties": { "clientConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:fsx/OpenZfsVolumeNfsExportsClientConfiguration:OpenZfsVolumeNfsExportsClientConfiguration" }, "description": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See `client_configurations` Block below for details.\n" } }, "type": "object", "required": [ "clientConfigurations" ] }, "aws:fsx/OpenZfsVolumeNfsExportsClientConfiguration:OpenZfsVolumeNfsExportsClientConfiguration": { "properties": { "clients": { "type": "string", "description": "A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24. By default, Amazon FSx uses the wildcard character when specifying the client.\n" }, "options": { "type": "array", "items": { "type": "string" }, "description": "The options to use when mounting the file system. Maximum of 20 items. See the [Linix NFS exports man page](https://linux.die.net/man/5/exports) for more information. `crossmount` and `sync` are used by default.\n" } }, "type": "object", "required": [ "clients", "options" ] }, "aws:fsx/OpenZfsVolumeOriginSnapshot:OpenZfsVolumeOriginSnapshot": { "properties": { "copyStrategy": { "type": "string", "description": "Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are `CLONE`, `FULL_COPY`, `INCREMENTAL_COPY`.\n" }, "snapshotArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the origin snapshot.\n" } }, "type": "object", "required": [ "copyStrategy", "snapshotArn" ] }, "aws:fsx/OpenZfsVolumeUserAndGroupQuota:OpenZfsVolumeUserAndGroupQuota": { "properties": { "id": { "type": "integer", "description": "The ID of the user or group. Valid values between `0` and `2147483647`\n" }, "storageCapacityQuotaGib": { "type": "integer", "description": "The amount of storage that the user or group can use in gibibytes (GiB). Valid values between `0` and `2147483647`\n* `Type` - (Required) - A value that specifies whether the quota applies to a user or group. Valid values are `USER` or `GROUP`.\n" }, "type": { "type": "string" } }, "type": "object", "required": [ "id", "storageCapacityQuotaGib", "type" ] }, "aws:fsx/WindowsFileSystemAuditLogConfiguration:WindowsFileSystemAuditLogConfiguration": { "properties": { "auditLogDestination": { "type": "string", "description": "The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when `file_access_audit_log_level` and `file_share_access_audit_log_level` are not set to `DISABLED`. The name of the Amazon CloudWatch Logs log group must begin with the `/aws/fsx` prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the `aws-fsx` prefix. If you do not provide a destination in `audit_log_destionation`, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.\n" }, "fileAccessAuditLogLevel": { "type": "string", "description": "Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are `SUCCESS_ONLY`, `FAILURE_ONLY`, `SUCCESS_AND_FAILURE`, and `DISABLED`. Default value is `DISABLED`.\n" }, "fileShareAccessAuditLogLevel": { "type": "string", "description": "Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are `SUCCESS_ONLY`, `FAILURE_ONLY`, `SUCCESS_AND_FAILURE`, and `DISABLED`. Default value is `DISABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "auditLogDestination" ] } } }, "aws:fsx/WindowsFileSystemDiskIopsConfiguration:WindowsFileSystemDiskIopsConfiguration": { "properties": { "iops": { "type": "integer", "description": "The total number of SSD IOPS provisioned for the file system.\n" }, "mode": { "type": "string", "description": "Specifies whether the number of IOPS for the file system is using the system. Valid values are `AUTOMATIC` and `USER_PROVISIONED`. Default value is `AUTOMATIC`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops" ] } } }, "aws:fsx/WindowsFileSystemSelfManagedActiveDirectory:WindowsFileSystemSelfManagedActiveDirectory": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in [RFC 1918](https://tools.ietf.org/html/rfc1918).\n" }, "domainName": { "type": "string", "description": "The fully qualified domain name of the self-managed AD directory. For example, `corp.example.com`.\n" }, "fileSystemAdministratorsGroup": { "type": "string", "description": "The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to `Domain Admins`.\n" }, "organizationalUnitDistinguishedName": { "type": "string", "description": "The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, `OU=FSx,DC=yourdomain,DC=corp,DC=com`. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253).\n" }, "password": { "type": "string", "description": "The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.\n", "secret": true }, "username": { "type": "string", "description": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.\n" } }, "type": "object", "required": [ "dnsIps", "domainName", "password", "username" ] }, "aws:fsx/getOntapFileSystemDiskIopsConfiguration:getOntapFileSystemDiskIopsConfiguration": { "properties": { "iops": { "type": "integer", "description": "The total number of SSD IOPS provisioned for the file system.\n" }, "mode": { "type": "string", "description": "Specifies whether the file system is using the `AUTOMATIC` setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a `USER_PROVISIONED` value.\n" } }, "type": "object", "required": [ "iops", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapFileSystemEndpoint:getOntapFileSystemEndpoint": { "properties": { "interclusters": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapFileSystemEndpointIntercluster:getOntapFileSystemEndpointIntercluster" }, "description": "A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.\n" }, "managements": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapFileSystemEndpointManagement:getOntapFileSystemEndpointManagement" }, "description": "A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.\n" } }, "type": "object", "required": [ "interclusters", "managements" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapFileSystemEndpointIntercluster:getOntapFileSystemEndpointIntercluster": { "properties": { "dnsName": { "type": "string", "description": "DNS name for the file system.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapFileSystemEndpointManagement:getOntapFileSystemEndpointManagement": { "properties": { "dnsName": { "type": "string", "description": "DNS name for the file system.\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineActiveDirectoryConfiguration:getOntapStorageVirtualMachineActiveDirectoryConfiguration": { "properties": { "netbiosName": { "type": "string", "description": "The NetBIOS name of the AD computer object to which the SVM is joined.\n" }, "selfManagedActiveDirectoryConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration:getOntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration" } } }, "type": "object", "required": [ "netbiosName", "selfManagedActiveDirectoryConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration:getOntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.\n" }, "domainName": { "type": "string", "description": "The fully qualified domain name of the self-managed AD directory.\n" }, "fileSystemAdministratorsGroup": { "type": "string", "description": "The name of the domain group whose members have administrative privileges for the FSx file system.\n" }, "organizationalUnitDistinguishedName": { "type": "string", "description": "The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.\n" }, "username": { "type": "string", "description": "The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.\n" } }, "type": "object", "required": [ "dnsIps", "domainName", "fileSystemAdministratorsGroup", "organizationalUnitDistinguishedName", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineEndpoint:getOntapStorageVirtualMachineEndpoint": { "properties": { "iscsis": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapStorageVirtualMachineEndpointIscsi:getOntapStorageVirtualMachineEndpointIscsi" } }, "managements": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapStorageVirtualMachineEndpointManagement:getOntapStorageVirtualMachineEndpointManagement" }, "description": "An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager. See SVM Endpoint below.\n" }, "nfs": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapStorageVirtualMachineEndpointNf:getOntapStorageVirtualMachineEndpointNf" }, "description": "An endpoint for connecting using the Network File System (NFS) protocol. See SVM Endpoint below.\n" }, "smbs": { "type": "array", "items": { "$ref": "#/types/aws:fsx/getOntapStorageVirtualMachineEndpointSmb:getOntapStorageVirtualMachineEndpointSmb" }, "description": "An endpoint for connecting using the Server Message Block (SMB) protocol. See SVM Endpoint below.\n" } }, "type": "object", "required": [ "iscsis", "managements", "nfs", "smbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineEndpointIscsi:getOntapStorageVirtualMachineEndpointIscsi": { "properties": { "dnsName": { "type": "string" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineEndpointManagement:getOntapStorageVirtualMachineEndpointManagement": { "properties": { "dnsName": { "type": "string" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineEndpointNf:getOntapStorageVirtualMachineEndpointNf": { "properties": { "dnsName": { "type": "string" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineEndpointSmb:getOntapStorageVirtualMachineEndpointSmb": { "properties": { "dnsName": { "type": "string" }, "ipAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dnsName", "ipAddresses" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachineFilter:getOntapStorageVirtualMachineFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/fsx/latest/APIReference/API_StorageVirtualMachineFilter.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. An SVM will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:fsx/getOntapStorageVirtualMachineLifecycleTransitionReason:getOntapStorageVirtualMachineLifecycleTransitionReason": { "properties": { "message": { "type": "string", "description": "A detailed message.\n" } }, "type": "object", "required": [ "message" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getOntapStorageVirtualMachinesFilter:getOntapStorageVirtualMachinesFilter": { "properties": { "name": { "type": "string", "description": "Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/fsx/latest/APIReference/API_StorageVirtualMachineFilter.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given field. An SVM will be selected if any one of the given values matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:fsx/getOpenZfsSnapshotFilter:getOpenZfsSnapshotFilter": { "properties": { "name": { "type": "string", "description": "Name of the snapshot.\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "aws:fsx/getWindowsFileSystemAuditLogConfiguration:getWindowsFileSystemAuditLogConfiguration": { "properties": { "auditLogDestination": { "type": "string" }, "fileAccessAuditLogLevel": { "type": "string" }, "fileShareAccessAuditLogLevel": { "type": "string" } }, "type": "object", "required": [ "auditLogDestination", "fileAccessAuditLogLevel", "fileShareAccessAuditLogLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:fsx/getWindowsFileSystemDiskIopsConfiguration:getWindowsFileSystemDiskIopsConfiguration": { "properties": { "iops": { "type": "integer" }, "mode": { "type": "string" } }, "type": "object", "required": [ "iops", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:gamelift/AliasRoutingStrategy:AliasRoutingStrategy": { "properties": { "fleetId": { "type": "string", "description": "ID of the GameLift Fleet to point the alias to.\n" }, "message": { "type": "string", "description": "Message text to be used with the `TERMINAL` routing strategy.\n" }, "type": { "type": "string", "description": "Type of routing strategyE.g., `SIMPLE` or `TERMINAL`\n" } }, "type": "object", "required": [ "type" ] }, "aws:gamelift/BuildStorageLocation:BuildStorageLocation": { "properties": { "bucket": { "type": "string", "description": "Name of your S3 bucket.\n", "willReplaceOnChanges": true }, "key": { "type": "string", "description": "Name of the zip file containing your build files.\n", "willReplaceOnChanges": true }, "objectVersion": { "type": "string", "description": "A specific version of the file. If not set, the latest version of the file is retrieved.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "ARN of the access role that allows Amazon GameLift to access your S3 bucket.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "key", "roleArn" ] }, "aws:gamelift/FleetCertificateConfiguration:FleetCertificateConfiguration": { "properties": { "certificateType": { "type": "string", "description": "Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are `DISABLED` and `GENERATED`. Default value is `DISABLED`.\n" } }, "type": "object" }, "aws:gamelift/FleetEc2InboundPermission:FleetEc2InboundPermission": { "properties": { "fromPort": { "type": "integer", "description": "Starting value for a range of allowed port numbers.\n" }, "ipRange": { "type": "string", "description": "Range of allowed IP addresses expressed in CIDR notationE.g., `000.000.000.000/[subnet mask]` or `0.0.0.0/[subnet mask]`.\n" }, "protocol": { "type": "string", "description": "Network communication protocol used by the fleetE.g., `TCP` or `UDP`\n" }, "toPort": { "type": "integer", "description": "Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than `from_port`.\n" } }, "type": "object", "required": [ "fromPort", "ipRange", "protocol", "toPort" ] }, "aws:gamelift/FleetResourceCreationLimitPolicy:FleetResourceCreationLimitPolicy": { "properties": { "newGameSessionsPerCreator": { "type": "integer", "description": "Maximum number of game sessions that an individual can create during the policy period.\n" }, "policyPeriodInMinutes": { "type": "integer", "description": "Time span used in evaluating the resource creation limit policy.\n" } }, "type": "object" }, "aws:gamelift/FleetRuntimeConfiguration:FleetRuntimeConfiguration": { "properties": { "gameSessionActivationTimeoutSeconds": { "type": "integer", "description": "Maximum amount of time (in seconds) that a game session can remain in status `ACTIVATING`.\n" }, "maxConcurrentGameSessionActivations": { "type": "integer", "description": "Maximum number of game sessions with status `ACTIVATING` to allow on an instance simultaneously.\n" }, "serverProcesses": { "type": "array", "items": { "$ref": "#/types/aws:gamelift/FleetRuntimeConfigurationServerProcess:FleetRuntimeConfigurationServerProcess" }, "description": "Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.\n" } }, "type": "object" }, "aws:gamelift/FleetRuntimeConfigurationServerProcess:FleetRuntimeConfigurationServerProcess": { "properties": { "concurrentExecutions": { "type": "integer", "description": "Number of server processes using this configuration to run concurrently on an instance.\n" }, "launchPath": { "type": "string", "description": "Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances `C:\\game`, and for Linux instances `/local/game`.\n" }, "parameters": { "type": "string", "description": "Optional list of parameters to pass to the server executable on launch.\n" } }, "type": "object", "required": [ "concurrentExecutions", "launchPath" ] }, "aws:gamelift/GameServerGroupAutoScalingPolicy:GameServerGroupAutoScalingPolicy": { "properties": { "estimatedInstanceWarmup": { "type": "integer", "description": "Length of time, in seconds, it takes for a new instance to start\nnew game server processes and register with GameLift FleetIQ.\nSpecifying a warm-up time can be useful, particularly with game servers that take a long time to start up,\nbecause it avoids prematurely starting new instances. Defaults to `60`.\n", "willReplaceOnChanges": true }, "targetTrackingConfiguration": { "$ref": "#/types/aws:gamelift/GameServerGroupAutoScalingPolicyTargetTrackingConfiguration:GameServerGroupAutoScalingPolicyTargetTrackingConfiguration" } }, "type": "object", "required": [ "targetTrackingConfiguration" ], "language": { "nodejs": { "requiredOutputs": [ "estimatedInstanceWarmup", "targetTrackingConfiguration" ] } } }, "aws:gamelift/GameServerGroupAutoScalingPolicyTargetTrackingConfiguration:GameServerGroupAutoScalingPolicyTargetTrackingConfiguration": { "properties": { "targetValue": { "type": "number", "description": "Desired value to use with a game server group target-based scaling policy.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "targetValue" ] }, "aws:gamelift/GameServerGroupInstanceDefinition:GameServerGroupInstanceDefinition": { "properties": { "instanceType": { "type": "string", "description": "An EC2 instance type.\n" }, "weightedCapacity": { "type": "string", "description": "Instance weighting that indicates how much this instance type contributes\nto the total capacity of a game server group.\nInstance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify\nthe most cost-effective options.\n" } }, "type": "object", "required": [ "instanceType" ] }, "aws:gamelift/GameServerGroupLaunchTemplate:GameServerGroupLaunchTemplate": { "properties": { "id": { "type": "string", "description": "A unique identifier for an existing EC2 launch template.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "A readable identifier for an existing EC2 launch template.\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "The version of the EC2 launch template to use. If none is set, the default is the first version created.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "name" ] } } }, "aws:gamelift/GameSessionQueuePlayerLatencyPolicy:GameSessionQueuePlayerLatencyPolicy": { "properties": { "maximumIndividualPlayerLatencyMilliseconds": { "type": "integer", "description": "Maximum latency value that is allowed for any player.\n" }, "policyDurationSeconds": { "type": "integer", "description": "Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.\n" } }, "type": "object", "required": [ "maximumIndividualPlayerLatencyMilliseconds" ] }, "aws:gamelift/MatchmakingConfigurationGameProperty:MatchmakingConfigurationGameProperty": { "properties": { "key": { "type": "string", "description": "A game property key\n" }, "value": { "type": "string", "description": "A game property value.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:gamelift/ScriptStorageLocation:ScriptStorageLocation": { "properties": { "bucket": { "type": "string", "description": "Name of your S3 bucket.\n" }, "key": { "type": "string", "description": "Name of the zip file containing your script files.\n" }, "objectVersion": { "type": "string", "description": "A specific version of the file. If not set, the latest version of the file is retrieved.\n" }, "roleArn": { "type": "string", "description": "ARN of the access role that allows Amazon GameLift to access your S3 bucket.\n" } }, "type": "object", "required": [ "bucket", "key", "roleArn" ] }, "aws:glacier/VaultNotification:VaultNotification": { "properties": { "events": { "type": "array", "items": { "type": "string" }, "description": "You can configure a vault to publish a notification for `ArchiveRetrievalCompleted` and `InventoryRetrievalCompleted` events.\n" }, "snsTopic": { "type": "string", "description": "The SNS Topic ARN.\n" } }, "type": "object", "required": [ "events", "snsTopic" ] }, "aws:globalaccelerator/AcceleratorAttributes:AcceleratorAttributes": { "properties": { "flowLogsEnabled": { "type": "boolean", "description": "Indicates whether flow logs are enabled. Defaults to `false`. Valid values: `true`, `false`.\n" }, "flowLogsS3Bucket": { "type": "string", "description": "The name of the Amazon S3 bucket for the flow logs. Required if `flow_logs_enabled` is `true`.\n" }, "flowLogsS3Prefix": { "type": "string", "description": "The prefix for the location in the Amazon S3 bucket for the flow logs. Required if `flow_logs_enabled` is `true`.\n" } }, "type": "object" }, "aws:globalaccelerator/AcceleratorIpSet:AcceleratorIpSet": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.\n" }, "ipFamily": { "type": "string", "description": "The type of IP addresses included in this IP set.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipAddresses", "ipFamily" ] } } }, "aws:globalaccelerator/CrossAccountAttachmentResource:CrossAccountAttachmentResource": { "properties": { "cidrBlock": { "type": "string", "description": "IP address range, in CIDR format, that is specified as resource.\n" }, "endpointId": { "type": "string", "description": "The endpoint ID for the endpoint that is specified as a AWS resource.\n" }, "region": { "type": "string", "description": "The AWS Region where a shared endpoint resource is located.\n" } }, "type": "object" }, "aws:globalaccelerator/CustomRoutingAcceleratorAttributes:CustomRoutingAcceleratorAttributes": { "properties": { "flowLogsEnabled": { "type": "boolean", "description": "Indicates whether flow logs are enabled. Defaults to `false`. Valid values: `true`, `false`.\n" }, "flowLogsS3Bucket": { "type": "string", "description": "The name of the Amazon S3 bucket for the flow logs. Required if `flow_logs_enabled` is `true`.\n" }, "flowLogsS3Prefix": { "type": "string", "description": "The prefix for the location in the Amazon S3 bucket for the flow logs. Required if `flow_logs_enabled` is `true`.\n" } }, "type": "object" }, "aws:globalaccelerator/CustomRoutingAcceleratorIpSet:CustomRoutingAcceleratorIpSet": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "The IP addresses to use for BYOIP accelerators. If not specified, the service assigns IP addresses. Valid values: 1 or 2 IPv4 addresses.\n" }, "ipFamily": { "type": "string", "description": "The type of IP addresses included in this IP set.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipAddresses", "ipFamily" ] } } }, "aws:globalaccelerator/CustomRoutingEndpointGroupDestinationConfiguration:CustomRoutingEndpointGroupDestinationConfiguration": { "properties": { "fromPort": { "type": "integer", "description": "The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either `\"TCP\"` or `\"UDP\"`.\n" }, "toPort": { "type": "integer", "description": "The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.\n" } }, "type": "object", "required": [ "fromPort", "protocols", "toPort" ] }, "aws:globalaccelerator/CustomRoutingEndpointGroupEndpointConfiguration:CustomRoutingEndpointGroupEndpointConfiguration": { "properties": { "endpointId": { "type": "string", "description": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.\n" } }, "type": "object" }, "aws:globalaccelerator/CustomRoutingListenerPortRange:CustomRoutingListenerPortRange": { "properties": { "fromPort": { "type": "integer", "description": "The first port in the range of ports, inclusive.\n" }, "toPort": { "type": "integer", "description": "The last port in the range of ports, inclusive.\n" } }, "type": "object" }, "aws:globalaccelerator/EndpointGroupEndpointConfiguration:EndpointGroupEndpointConfiguration": { "properties": { "attachmentArn": { "type": "string", "description": "An ARN of an exposed cross-account attachment. See the [AWS documentation](https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) for more details.\n" }, "clientIpPreservationEnabled": { "type": "boolean", "description": "Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the [AWS documentation](https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) for more details. The default value is `false`.\n**Note:** When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named `GlobalAccelerator` that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a `DependencyViolation` error. This cannot be resolved by re-running the provider.\n" }, "endpointId": { "type": "string", "description": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.\n" }, "weight": { "type": "integer", "description": "The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clientIpPreservationEnabled" ] } } }, "aws:globalaccelerator/EndpointGroupPortOverride:EndpointGroupPortOverride": { "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.\n" }, "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.\n" } }, "type": "object", "required": [ "endpointPort", "listenerPort" ] }, "aws:globalaccelerator/ListenerPortRange:ListenerPortRange": { "properties": { "fromPort": { "type": "integer", "description": "The first port in the range of ports, inclusive.\n" }, "toPort": { "type": "integer", "description": "The last port in the range of ports, inclusive.\n" } }, "type": "object" }, "aws:globalaccelerator/getAcceleratorAttribute:getAcceleratorAttribute": { "properties": { "flowLogsEnabled": { "type": "boolean" }, "flowLogsS3Bucket": { "type": "string" }, "flowLogsS3Prefix": { "type": "string" } }, "type": "object", "required": [ "flowLogsEnabled", "flowLogsS3Bucket", "flowLogsS3Prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:globalaccelerator/getAcceleratorIpSet:getAcceleratorIpSet": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" } }, "ipFamily": { "type": "string" } }, "type": "object", "required": [ "ipAddresses", "ipFamily" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:globalaccelerator/getCustomRoutingAcceleratorAttribute:getCustomRoutingAcceleratorAttribute": { "properties": { "flowLogsEnabled": { "type": "boolean" }, "flowLogsS3Bucket": { "type": "string" }, "flowLogsS3Prefix": { "type": "string" } }, "type": "object", "required": [ "flowLogsEnabled", "flowLogsS3Bucket", "flowLogsS3Prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:globalaccelerator/getCustomRoutingAcceleratorIpSet:getCustomRoutingAcceleratorIpSet": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" } }, "ipFamily": { "type": "string" } }, "type": "object", "required": [ "ipAddresses", "ipFamily" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/CatalogDatabaseCreateTableDefaultPermission:CatalogDatabaseCreateTableDefaultPermission": { "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions that are granted to the principal.\n" }, "principal": { "$ref": "#/types/aws:glue/CatalogDatabaseCreateTableDefaultPermissionPrincipal:CatalogDatabaseCreateTableDefaultPermissionPrincipal", "description": "The principal who is granted permissions.. See `principal` below.\n" } }, "type": "object" }, "aws:glue/CatalogDatabaseCreateTableDefaultPermissionPrincipal:CatalogDatabaseCreateTableDefaultPermissionPrincipal": { "properties": { "dataLakePrincipalIdentifier": { "type": "string", "description": "An identifier for the Lake Formation principal.\n" } }, "type": "object" }, "aws:glue/CatalogDatabaseFederatedDatabase:CatalogDatabaseFederatedDatabase": { "properties": { "connectionName": { "type": "string", "description": "Name of the connection to the external metastore.\n" }, "identifier": { "type": "string", "description": "Unique identifier for the federated database.\n" } }, "type": "object" }, "aws:glue/CatalogDatabaseTargetDatabase:CatalogDatabaseTargetDatabase": { "properties": { "catalogId": { "type": "string", "description": "ID of the Data Catalog in which the database resides.\n" }, "databaseName": { "type": "string", "description": "Name of the catalog database.\n" }, "region": { "type": "string", "description": "Region of the target database.\n" } }, "type": "object", "required": [ "catalogId", "databaseName" ] }, "aws:glue/CatalogTableOpenTableFormatInput:CatalogTableOpenTableFormatInput": { "properties": { "icebergInput": { "$ref": "#/types/aws:glue/CatalogTableOpenTableFormatInputIcebergInput:CatalogTableOpenTableFormatInputIcebergInput", "description": "Configuration block for iceberg table config. See `iceberg_input` below.\n" } }, "type": "object", "required": [ "icebergInput" ] }, "aws:glue/CatalogTableOpenTableFormatInputIcebergInput:CatalogTableOpenTableFormatInputIcebergInput": { "properties": { "metadataOperation": { "type": "string", "description": "A required metadata operation. Can only be set to CREATE.\n" }, "version": { "type": "string", "description": "The table version for the Iceberg table. Defaults to 2.\n" } }, "type": "object", "required": [ "metadataOperation" ] }, "aws:glue/CatalogTableOptimizerConfiguration:CatalogTableOptimizerConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Indicates whether the table optimizer is enabled.\n" }, "orphanFileDeletionConfiguration": { "$ref": "#/types/aws:glue/CatalogTableOptimizerConfigurationOrphanFileDeletionConfiguration:CatalogTableOptimizerConfigurationOrphanFileDeletionConfiguration", "description": "The configuration block for an orphan file deletion optimizer. See Orphan File Deletion Configuration for additional details.\n" }, "retentionConfiguration": { "$ref": "#/types/aws:glue/CatalogTableOptimizerConfigurationRetentionConfiguration:CatalogTableOptimizerConfigurationRetentionConfiguration", "description": "The configuration block for a snapshot retention optimizer. See Retention Configuration for additional details.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to use for the table optimizer.\n" } }, "type": "object", "required": [ "enabled", "roleArn" ] }, "aws:glue/CatalogTableOptimizerConfigurationOrphanFileDeletionConfiguration:CatalogTableOptimizerConfigurationOrphanFileDeletionConfiguration": { "properties": { "icebergConfiguration": { "$ref": "#/types/aws:glue/CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfiguration:CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfiguration", "description": "The configuration for an Iceberg orphan file deletion optimizer.\n" } }, "type": "object" }, "aws:glue/CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfiguration:CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfiguration": { "properties": { "location": { "type": "string", "description": "Specifies a directory in which to look for files. You may choose a sub-directory rather than the top-level table location. Defaults to the table's location.\n" }, "orphanFileRetentionPeriodInDays": { "type": "integer", "description": "The number of days that orphan files should be retained before file deletion. Defaults to `3`.\n" } }, "type": "object" }, "aws:glue/CatalogTableOptimizerConfigurationRetentionConfiguration:CatalogTableOptimizerConfigurationRetentionConfiguration": { "properties": { "icebergConfiguration": { "$ref": "#/types/aws:glue/CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfiguration:CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfiguration", "description": "The configuration for an Iceberg snapshot retention optimizer.\n" } }, "type": "object" }, "aws:glue/CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfiguration:CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfiguration": { "properties": { "cleanExpiredFiles": { "type": "boolean", "description": "If set to `false`, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted. Defaults to `false`.\n" }, "numberOfSnapshotsToRetain": { "type": "integer", "description": "The number of Iceberg snapshots to retain within the retention period. Defaults to `1` or the corresponding Iceberg table configuration field if it exists.\n" }, "snapshotRetentionPeriodInDays": { "type": "integer", "description": "The number of days to retain the Iceberg snapshots. Defaults to `5`, or the corresponding Iceberg table configuration field if it exists.\n" } }, "type": "object" }, "aws:glue/CatalogTablePartitionIndex:CatalogTablePartitionIndex": { "properties": { "indexName": { "type": "string", "description": "Name of the partition index.\n" }, "indexStatus": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Keys for the partition index.\n" } }, "type": "object", "required": [ "indexName", "keys" ], "language": { "nodejs": { "requiredOutputs": [ "indexName", "indexStatus", "keys" ] } } }, "aws:glue/CatalogTablePartitionKey:CatalogTablePartitionKey": { "properties": { "comment": { "type": "string", "description": "Free-form text comment.\n" }, "name": { "type": "string", "description": "Name of the Partition Key.\n" }, "type": { "type": "string", "description": "Datatype of data in the Partition Key.\n" } }, "type": "object", "required": [ "name" ] }, "aws:glue/CatalogTableStorageDescriptor:CatalogTableStorageDescriptor": { "properties": { "additionalLocations": { "type": "array", "items": { "type": "string" }, "description": "List of locations that point to the path where a Delta table is located.\n" }, "bucketColumns": { "type": "array", "items": { "type": "string" }, "description": "List of reducer grouping columns, clustering columns, and bucketing columns in the table.\n" }, "columns": { "type": "array", "items": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorColumn:CatalogTableStorageDescriptorColumn" }, "description": "Configuration block for columns in the table. See `columns` below.\n" }, "compressed": { "type": "boolean", "description": "Whether the data in the table is compressed.\n" }, "inputFormat": { "type": "string", "description": "Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.\n" }, "location": { "type": "string", "description": "Physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.\n" }, "numberOfBuckets": { "type": "integer", "description": "Must be specified if the table contains any dimension columns.\n" }, "outputFormat": { "type": "string", "description": "Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "User-supplied properties in key-value form.\n" }, "schemaReference": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorSchemaReference:CatalogTableStorageDescriptorSchemaReference", "description": "Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.\n" }, "serDeInfo": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorSerDeInfo:CatalogTableStorageDescriptorSerDeInfo", "description": "Configuration block for serialization and deserialization (\"SerDe\") information. See `ser_de_info` below.\n" }, "skewedInfo": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorSkewedInfo:CatalogTableStorageDescriptorSkewedInfo", "description": "Configuration block with information about values that appear very frequently in a column (skewed values). See `skewed_info` below.\n" }, "sortColumns": { "type": "array", "items": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorSortColumn:CatalogTableStorageDescriptorSortColumn" }, "description": "Configuration block for the sort order of each bucket in the table. See `sort_columns` below.\n" }, "storedAsSubDirectories": { "type": "boolean", "description": "Whether the table data is stored in subdirectories.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "columns" ] } } }, "aws:glue/CatalogTableStorageDescriptorColumn:CatalogTableStorageDescriptorColumn": { "properties": { "comment": { "type": "string", "description": "Free-form text comment.\n" }, "name": { "type": "string", "description": "Name of the Column.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pairs defining properties associated with the column.\n" }, "type": { "type": "string", "description": "Datatype of data in the Column.\n" } }, "type": "object", "required": [ "name" ] }, "aws:glue/CatalogTableStorageDescriptorSchemaReference:CatalogTableStorageDescriptorSchemaReference": { "properties": { "schemaId": { "$ref": "#/types/aws:glue/CatalogTableStorageDescriptorSchemaReferenceSchemaId:CatalogTableStorageDescriptorSchemaReferenceSchemaId", "description": "Configuration block that contains schema identity fields. Either this or the `schema_version_id` has to be provided. See `schema_id` below.\n" }, "schemaVersionId": { "type": "string", "description": "Unique ID assigned to a version of the schema. Either this or the `schema_id` has to be provided.\n" }, "schemaVersionNumber": { "type": "integer", "description": "Version number of the schema.\n" } }, "type": "object", "required": [ "schemaVersionNumber" ] }, "aws:glue/CatalogTableStorageDescriptorSchemaReferenceSchemaId:CatalogTableStorageDescriptorSchemaReferenceSchemaId": { "properties": { "registryName": { "type": "string", "description": "Name of the schema registry that contains the schema. Must be provided when `schema_name` is specified and conflicts with `schema_arn`.\n" }, "schemaArn": { "type": "string", "description": "ARN of the schema. One of `schema_arn` or `schema_name` has to be provided.\n" }, "schemaName": { "type": "string", "description": "Name of the schema. One of `schema_arn` or `schema_name` has to be provided.\n" } }, "type": "object" }, "aws:glue/CatalogTableStorageDescriptorSerDeInfo:CatalogTableStorageDescriptorSerDeInfo": { "properties": { "name": { "type": "string", "description": "Name of the SerDe.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of initialization parameters for the SerDe, in key-value form.\n" }, "serializationLibrary": { "type": "string", "description": "Usually the class that implements the SerDe. An example is `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.\n" } }, "type": "object" }, "aws:glue/CatalogTableStorageDescriptorSkewedInfo:CatalogTableStorageDescriptorSkewedInfo": { "properties": { "skewedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "List of names of columns that contain skewed values.\n" }, "skewedColumnValueLocationMaps": { "type": "object", "additionalProperties": { "type": "string" }, "description": "List of values that appear so frequently as to be considered skewed.\n" }, "skewedColumnValues": { "type": "array", "items": { "type": "string" }, "description": "Map of skewed values to the columns that contain them.\n" } }, "type": "object" }, "aws:glue/CatalogTableStorageDescriptorSortColumn:CatalogTableStorageDescriptorSortColumn": { "properties": { "column": { "type": "string", "description": "Name of the column.\n" }, "sortOrder": { "type": "integer", "description": "Whether the column is sorted in ascending (`1`) or descending order (`0`).\n" } }, "type": "object", "required": [ "column", "sortOrder" ] }, "aws:glue/CatalogTableTargetTable:CatalogTableTargetTable": { "properties": { "catalogId": { "type": "string", "description": "ID of the Data Catalog in which the table resides.\n" }, "databaseName": { "type": "string", "description": "Name of the catalog database that contains the target table.\n" }, "name": { "type": "string", "description": "Name of the target table.\n" }, "region": { "type": "string", "description": "Region of the target table.\n" } }, "type": "object", "required": [ "catalogId", "databaseName", "name" ] }, "aws:glue/ClassifierCsvClassifier:ClassifierCsvClassifier": { "properties": { "allowSingleColumn": { "type": "boolean", "description": "Enables the processing of files that contain only one column.\n" }, "containsHeader": { "type": "string", "description": "Indicates whether the CSV file contains a header. This can be one of \"ABSENT\", \"PRESENT\", or \"UNKNOWN\".\n" }, "customDatatypeConfigured": { "type": "boolean", "description": "Enables the custom datatype to be configured.\n" }, "customDatatypes": { "type": "array", "items": { "type": "string" }, "description": "A list of supported custom datatypes. Valid values are `BINARY`, `BOOLEAN`, `DATE`, `DECIMAL`, `DOUBLE`, `FLOAT`, `INT`, `LONG`, `SHORT`, `STRING`, `TIMESTAMP`.\n" }, "delimiter": { "type": "string", "description": "The delimiter used in the CSV to separate columns.\n" }, "disableValueTrimming": { "type": "boolean", "description": "Specifies whether to trim column values.\n" }, "headers": { "type": "array", "items": { "type": "string" }, "description": "A list of strings representing column names.\n" }, "quoteSymbol": { "type": "string", "description": "A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.\n" }, "serde": { "type": "string", "description": "The SerDe for processing CSV. Valid values are `OpenCSVSerDe`, `LazySimpleSerDe`, `None`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serde" ] } } }, "aws:glue/ClassifierGrokClassifier:ClassifierGrokClassifier": { "properties": { "classification": { "type": "string", "description": "An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.\n" }, "customPatterns": { "type": "string", "description": "Custom grok patterns used by this classifier.\n" }, "grokPattern": { "type": "string", "description": "The grok pattern used by this classifier.\n" } }, "type": "object", "required": [ "classification", "grokPattern" ] }, "aws:glue/ClassifierJsonClassifier:ClassifierJsonClassifier": { "properties": { "jsonPath": { "type": "string", "description": "A `JsonPath` string defining the JSON data for the classifier to classify. AWS Glue supports a subset of `JsonPath`, as described in [Writing JsonPath Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json).\n" } }, "type": "object", "required": [ "jsonPath" ] }, "aws:glue/ClassifierXmlClassifier:ClassifierXmlClassifier": { "properties": { "classification": { "type": "string", "description": "An identifier of the data format that the classifier matches.\n" }, "rowTag": { "type": "string", "description": "The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by `/\u003e`). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, `\u003crow item_a=\"A\" item_b=\"B\"\u003e\u003c/row\u003e` is okay, but `\u003crow item_a=\"A\" item_b=\"B\" /\u003e` is not).\n" } }, "type": "object", "required": [ "classification", "rowTag" ] }, "aws:glue/ConnectionPhysicalConnectionRequirements:ConnectionPhysicalConnectionRequirements": { "properties": { "availabilityZone": { "type": "string", "description": "The availability zone of the connection. This field is redundant and implied by `subnet_id`, but is currently an api requirement.\n" }, "securityGroupIdLists": { "type": "array", "items": { "type": "string" }, "description": "The security group ID list used by the connection.\n" }, "subnetId": { "type": "string", "description": "The subnet ID used by the connection.\n" } }, "type": "object" }, "aws:glue/CrawlerCatalogTarget:CrawlerCatalogTarget": { "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.\n" }, "databaseName": { "type": "string", "description": "The name of the Glue database to be synchronized.\n" }, "dlqEventQueueArn": { "type": "string", "description": "A valid Amazon SQS ARN.\n\n\u003e **Note:** `deletion_behavior` of catalog target doesn't support `DEPRECATE_IN_DATABASE`.\n\n\u003e **Note:** `configuration` for catalog target crawlers will have `{ ... \"Grouping\": { \"TableGroupingPolicy\": \"CombineCompatibleSchemas\"} }` by default.\n" }, "eventQueueArn": { "type": "string", "description": "A valid Amazon SQS ARN.\n" }, "tables": { "type": "array", "items": { "type": "string" }, "description": "A list of catalog tables to be synchronized.\n" } }, "type": "object", "required": [ "databaseName", "tables" ] }, "aws:glue/CrawlerDeltaTarget:CrawlerDeltaTarget": { "properties": { "connectionName": { "type": "string", "description": "The name of the connection to use to connect to the Delta table target.\n" }, "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.\n" }, "deltaTables": { "type": "array", "items": { "type": "string" }, "description": "A list of the Amazon S3 paths to the Delta tables.\n" }, "writeManifest": { "type": "boolean", "description": "Specifies whether to write the manifest files to the Delta table path.\n" } }, "type": "object", "required": [ "deltaTables", "writeManifest" ] }, "aws:glue/CrawlerDynamodbTarget:CrawlerDynamodbTarget": { "properties": { "path": { "type": "string", "description": "The name of the DynamoDB table to crawl.\n" }, "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. defaults to `true`.\n" }, "scanRate": { "type": "number", "description": "The percentage of the configured read capacity units to use by the AWS Glue crawler. The valid values are null or a value between 0.1 to 1.5.\n" } }, "type": "object", "required": [ "path" ] }, "aws:glue/CrawlerHudiTarget:CrawlerHudiTarget": { "properties": { "connectionName": { "type": "string", "description": "The name of the connection to use to connect to the Hudi target.\n" }, "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns used to exclude from the crawl.\n" }, "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. Valid values are between `1` and `20`.\n" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "One or more Amazon S3 paths that contains Hudi metadata folders as s3://bucket/prefix.\n" } }, "type": "object", "required": [ "maximumTraversalDepth", "paths" ] }, "aws:glue/CrawlerIcebergTarget:CrawlerIcebergTarget": { "properties": { "connectionName": { "type": "string", "description": "The name of the connection to use to connect to the Iceberg target.\n" }, "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns used to exclude from the crawl.\n" }, "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. Valid values are between `1` and `20`.\n" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.\n" } }, "type": "object", "required": [ "maximumTraversalDepth", "paths" ] }, "aws:glue/CrawlerJdbcTarget:CrawlerJdbcTarget": { "properties": { "connectionName": { "type": "string", "description": "The name of the connection to use to connect to the JDBC target.\n" }, "enableAdditionalMetadatas": { "type": "array", "items": { "type": "string" }, "description": "Specify a value of `RAWTYPES` or `COMMENTS` to enable additional metadata intable responses. `RAWTYPES` provides the native-level datatype. `COMMENTS` provides comments associated with a column or table in the database.\n" }, "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns used to exclude from the crawl.\n" }, "path": { "type": "string", "description": "The path of the JDBC target.\n" } }, "type": "object", "required": [ "connectionName", "path" ] }, "aws:glue/CrawlerLakeFormationConfiguration:CrawlerLakeFormationConfiguration": { "properties": { "accountId": { "type": "string", "description": "Required for cross account crawls. For same account crawls as the target data, this can omitted.\n" }, "useLakeFormationCredentials": { "type": "boolean", "description": "Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId" ] } } }, "aws:glue/CrawlerLineageConfiguration:CrawlerLineageConfiguration": { "properties": { "crawlerLineageSettings": { "type": "string", "description": "Specifies whether data lineage is enabled for the crawler. Valid values are: `ENABLE` and `DISABLE`. Default value is `DISABLE`.\n" } }, "type": "object" }, "aws:glue/CrawlerMongodbTarget:CrawlerMongodbTarget": { "properties": { "connectionName": { "type": "string", "description": "The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.\n" }, "path": { "type": "string", "description": "The path of the Amazon DocumentDB or MongoDB target (database/collection).\n" }, "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. Default value is `true`.\n" } }, "type": "object", "required": [ "connectionName", "path" ] }, "aws:glue/CrawlerRecrawlPolicy:CrawlerRecrawlPolicy": { "properties": { "recrawlBehavior": { "type": "string", "description": "Specifies whether to crawl the entire dataset again, crawl only folders that were added since the last crawler run, or crawl what S3 notifies the crawler of via SQS. Valid Values are: `CRAWL_EVENT_MODE`, `CRAWL_EVERYTHING` and `CRAWL_NEW_FOLDERS_ONLY`. Default value is `CRAWL_EVERYTHING`.\n" } }, "type": "object" }, "aws:glue/CrawlerS3Target:CrawlerS3Target": { "properties": { "connectionName": { "type": "string", "description": "The name of a connection which allows crawler to access data in S3 within a VPC.\n" }, "dlqEventQueueArn": { "type": "string", "description": "The ARN of the dead-letter SQS queue.\n" }, "eventQueueArn": { "type": "string", "description": "The ARN of the SQS queue to receive S3 notifications from.\n" }, "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns used to exclude from the crawl.\n" }, "path": { "type": "string", "description": "The path to the Amazon S3 target.\n" }, "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.\n" } }, "type": "object", "required": [ "path" ] }, "aws:glue/CrawlerSchemaChangePolicy:CrawlerSchemaChangePolicy": { "properties": { "deleteBehavior": { "type": "string", "description": "The deletion behavior when the crawler finds a deleted object. Valid values: `LOG`, `DELETE_FROM_DATABASE`, or `DEPRECATE_IN_DATABASE`. Defaults to `DEPRECATE_IN_DATABASE`.\n" }, "updateBehavior": { "type": "string", "description": "The update behavior when the crawler finds a changed schema. Valid values: `LOG` or `UPDATE_IN_DATABASE`. Defaults to `UPDATE_IN_DATABASE`.\n" } }, "type": "object" }, "aws:glue/DataCatalogEncryptionSettingsDataCatalogEncryptionSettings:DataCatalogEncryptionSettingsDataCatalogEncryptionSettings": { "properties": { "connectionPasswordEncryption": { "$ref": "#/types/aws:glue/DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption:DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption", "description": "When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. see Connection Password Encryption.\n" }, "encryptionAtRest": { "$ref": "#/types/aws:glue/DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest:DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest", "description": "Specifies the encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.\n" } }, "type": "object", "required": [ "connectionPasswordEncryption", "encryptionAtRest" ] }, "aws:glue/DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption:DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsConnectionPasswordEncryption": { "properties": { "awsKmsKeyId": { "type": "string", "description": "A KMS key ARN that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least `kms:Encrypt` permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.\n" }, "returnConnectionPasswordEncrypted": { "type": "boolean", "description": "When set to `true`, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.\n" } }, "type": "object", "required": [ "returnConnectionPasswordEncrypted" ] }, "aws:glue/DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest:DataCatalogEncryptionSettingsDataCatalogEncryptionSettingsEncryptionAtRest": { "properties": { "catalogEncryptionMode": { "type": "string", "description": "The encryption-at-rest mode for encrypting Data Catalog data. Valid values: `DISABLED`, `SSE-KMS`, `SSE-KMS-WITH-SERVICE-ROLE`.\n" }, "catalogEncryptionServiceRole": { "type": "string", "description": "The ARN of the AWS IAM role used for accessing encrypted Data Catalog data.\n" }, "sseAwsKmsKeyId": { "type": "string", "description": "The ARN of the AWS KMS key to use for encryption at rest.\n" } }, "type": "object", "required": [ "catalogEncryptionMode" ] }, "aws:glue/DataQualityRulesetTargetTable:DataQualityRulesetTargetTable": { "properties": { "catalogId": { "type": "string", "description": "The catalog id where the AWS Glue table exists.\n", "willReplaceOnChanges": true }, "databaseName": { "type": "string", "description": "Name of the database where the AWS Glue table exists.\n", "willReplaceOnChanges": true }, "tableName": { "type": "string", "description": "Name of the AWS Glue table.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName", "tableName" ] }, "aws:glue/JobCommand:JobCommand": { "properties": { "name": { "type": "string", "description": "The name of the job command. Defaults to `glueetl`. Use `pythonshell` for Python Shell Job Type, `glueray` for Ray Job Type, or `gluestreaming` for Streaming Job Type. `max_capacity` needs to be set if `pythonshell` is chosen.\n" }, "pythonVersion": { "type": "string", "description": "The Python version being used to execute a Python shell job. Allowed values are 2, 3 or 3.9. Version 3 refers to Python 3.11 when `glue_version` is set to 5.0.\n" }, "runtime": { "type": "string", "description": "In Ray jobs, runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see [Working with Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html#author-job-ray-runtimes) in the Glue Developer Guide.\n" }, "scriptLocation": { "type": "string", "description": "Specifies the S3 path to a script that executes a job.\n" } }, "type": "object", "required": [ "scriptLocation" ], "language": { "nodejs": { "requiredOutputs": [ "pythonVersion", "runtime", "scriptLocation" ] } } }, "aws:glue/JobExecutionProperty:JobExecutionProperty": { "properties": { "maxConcurrentRuns": { "type": "integer", "description": "The maximum number of concurrent runs allowed for a job. The default is 1.\n" } }, "type": "object" }, "aws:glue/JobNotificationProperty:JobNotificationProperty": { "properties": { "notifyDelayAfter": { "type": "integer", "description": "After a job run starts, the number of minutes to wait before sending a job run delay notification.\n" } }, "type": "object" }, "aws:glue/JobSourceControlDetails:JobSourceControlDetails": { "properties": { "authStrategy": { "type": "string", "description": "The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token. Valid values are: `PERSONAL_ACCESS_TOKEN` and `AWS_SECRETS_MANAGER`.\n" }, "authToken": { "type": "string", "description": "The value of an authorization token.\n", "secret": true }, "branch": { "type": "string", "description": "A branch in the remote repository.\n" }, "folder": { "type": "string", "description": "A folder in the remote repository.\n" }, "lastCommitId": { "type": "string", "description": "The last commit ID for a commit in the remote repository.\n" }, "owner": { "type": "string", "description": "The owner of the remote repository that contains the job artifacts.\n" }, "provider": { "type": "string", "description": "The provider for the remote repository. Valid values are: `GITHUB`, `GITLAB`, `BITBUCKET`, and `AWS_CODE_COMMIT`.\n" }, "repository": { "type": "string", "description": "The name of the remote repository that contains the job artifacts.\n" } }, "type": "object" }, "aws:glue/MLTransformInputRecordTable:MLTransformInputRecordTable": { "properties": { "catalogId": { "type": "string", "description": "A unique identifier for the AWS Glue Data Catalog.\n" }, "connectionName": { "type": "string", "description": "The name of the connection to the AWS Glue Data Catalog.\n" }, "databaseName": { "type": "string", "description": "A database name in the AWS Glue Data Catalog.\n" }, "tableName": { "type": "string", "description": "A table name in the AWS Glue Data Catalog.\n" } }, "type": "object", "required": [ "databaseName", "tableName" ] }, "aws:glue/MLTransformParameters:MLTransformParameters": { "properties": { "findMatchesParameters": { "$ref": "#/types/aws:glue/MLTransformParametersFindMatchesParameters:MLTransformParametersFindMatchesParameters", "description": "The parameters for the find matches algorithm. see Find Matches Parameters.\n" }, "transformType": { "type": "string", "description": "The type of machine learning transform. For information about the types of machine learning transforms, see [Creating Machine Learning Transforms](http://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html).\n" } }, "type": "object", "required": [ "findMatchesParameters", "transformType" ] }, "aws:glue/MLTransformParametersFindMatchesParameters:MLTransformParametersFindMatchesParameters": { "properties": { "accuracyCostTradeOff": { "type": "number", "description": "The value that is selected when tuning your transform for a balance between accuracy and cost.\n" }, "enforceProvidedLabels": { "type": "boolean", "description": "The value to switch on or off to force the output to match the provided labels from users.\n" }, "precisionRecallTradeOff": { "type": "number", "description": "The value selected when tuning your transform for a balance between precision and recall.\n" }, "primaryKeyColumnName": { "type": "string", "description": "The name of a column that uniquely identifies rows in the source table.\n" } }, "type": "object" }, "aws:glue/MLTransformSchema:MLTransformSchema": { "properties": { "dataType": { "type": "string", "description": "The type of data in the column.\n" }, "name": { "type": "string", "description": "The name you assign to this ML Transform. It must be unique in your account.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dataType", "name" ] } } }, "aws:glue/PartitionIndexPartitionIndex:PartitionIndexPartitionIndex": { "properties": { "indexName": { "type": "string", "description": "Name of the partition index.\n", "willReplaceOnChanges": true }, "indexStatus": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Keys for the partition index.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "indexStatus" ] } } }, "aws:glue/PartitionStorageDescriptor:PartitionStorageDescriptor": { "properties": { "additionalLocations": { "type": "array", "items": { "type": "string" }, "description": "List of locations that point to the path where a Delta table is located.\n" }, "bucketColumns": { "type": "array", "items": { "type": "string" }, "description": "A list of reducer grouping columns, clustering columns, and bucketing columns in the table.\n" }, "columns": { "type": "array", "items": { "$ref": "#/types/aws:glue/PartitionStorageDescriptorColumn:PartitionStorageDescriptorColumn" }, "description": "A list of the Columns in the table.\n" }, "compressed": { "type": "boolean", "description": "True if the data in the table is compressed, or False if not.\n" }, "inputFormat": { "type": "string", "description": "The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.\n" }, "location": { "type": "string", "description": "The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.\n" }, "numberOfBuckets": { "type": "integer", "description": "Must be specified if the table contains any dimension columns.\n" }, "outputFormat": { "type": "string", "description": "The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "User-supplied properties in key-value form.\n" }, "serDeInfo": { "$ref": "#/types/aws:glue/PartitionStorageDescriptorSerDeInfo:PartitionStorageDescriptorSerDeInfo", "description": "Serialization/deserialization (SerDe) information.\n" }, "skewedInfo": { "$ref": "#/types/aws:glue/PartitionStorageDescriptorSkewedInfo:PartitionStorageDescriptorSkewedInfo", "description": "Information about values that appear very frequently in a column (skewed values).\n" }, "sortColumns": { "type": "array", "items": { "$ref": "#/types/aws:glue/PartitionStorageDescriptorSortColumn:PartitionStorageDescriptorSortColumn" }, "description": "A list of Order objects specifying the sort order of each bucket in the table.\n" }, "storedAsSubDirectories": { "type": "boolean", "description": "True if the table data is stored in subdirectories, or False if not.\n" } }, "type": "object" }, "aws:glue/PartitionStorageDescriptorColumn:PartitionStorageDescriptorColumn": { "properties": { "comment": { "type": "string", "description": "Free-form text comment.\n" }, "name": { "type": "string" }, "type": { "type": "string", "description": "The datatype of data in the Column.\n" } }, "type": "object", "required": [ "name" ] }, "aws:glue/PartitionStorageDescriptorSerDeInfo:PartitionStorageDescriptorSerDeInfo": { "properties": { "name": { "type": "string", "description": "Name of the SerDe.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of initialization parameters for the SerDe, in key-value form.\n" }, "serializationLibrary": { "type": "string", "description": "Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.\n" } }, "type": "object" }, "aws:glue/PartitionStorageDescriptorSkewedInfo:PartitionStorageDescriptorSkewedInfo": { "properties": { "skewedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "A list of names of columns that contain skewed values.\n" }, "skewedColumnValueLocationMaps": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A list of values that appear so frequently as to be considered skewed.\n" }, "skewedColumnValues": { "type": "array", "items": { "type": "string" }, "description": "A map of skewed values to the columns that contain them.\n" } }, "type": "object" }, "aws:glue/PartitionStorageDescriptorSortColumn:PartitionStorageDescriptorSortColumn": { "properties": { "column": { "type": "string", "description": "The name of the column.\n" }, "sortOrder": { "type": "integer", "description": "Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).\n" } }, "type": "object", "required": [ "column", "sortOrder" ] }, "aws:glue/SecurityConfigurationEncryptionConfiguration:SecurityConfigurationEncryptionConfiguration": { "properties": { "cloudwatchEncryption": { "$ref": "#/types/aws:glue/SecurityConfigurationEncryptionConfigurationCloudwatchEncryption:SecurityConfigurationEncryptionConfigurationCloudwatchEncryption", "willReplaceOnChanges": true }, "jobBookmarksEncryption": { "$ref": "#/types/aws:glue/SecurityConfigurationEncryptionConfigurationJobBookmarksEncryption:SecurityConfigurationEncryptionConfigurationJobBookmarksEncryption", "willReplaceOnChanges": true }, "s3Encryption": { "$ref": "#/types/aws:glue/SecurityConfigurationEncryptionConfigurationS3Encryption:SecurityConfigurationEncryptionConfigurationS3Encryption", "description": "A `s3_encryption ` block as described below, which contains encryption configuration for S3 data.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "cloudwatchEncryption", "jobBookmarksEncryption", "s3Encryption" ] }, "aws:glue/SecurityConfigurationEncryptionConfigurationCloudwatchEncryption:SecurityConfigurationEncryptionConfigurationCloudwatchEncryption": { "properties": { "cloudwatchEncryptionMode": { "type": "string", "description": "Encryption mode to use for CloudWatch data. Valid values: `DISABLED`, `SSE-KMS`. Default value: `DISABLED`.\n", "willReplaceOnChanges": true }, "kmsKeyArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:glue/SecurityConfigurationEncryptionConfigurationJobBookmarksEncryption:SecurityConfigurationEncryptionConfigurationJobBookmarksEncryption": { "properties": { "jobBookmarksEncryptionMode": { "type": "string", "description": "Encryption mode to use for job bookmarks data. Valid values: `CSE-KMS`, `DISABLED`. Default value: `DISABLED`.\n", "willReplaceOnChanges": true }, "kmsKeyArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:glue/SecurityConfigurationEncryptionConfigurationS3Encryption:SecurityConfigurationEncryptionConfigurationS3Encryption": { "properties": { "kmsKeyArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n", "willReplaceOnChanges": true }, "s3EncryptionMode": { "type": "string", "description": "Encryption mode to use for S3 data. Valid values: `DISABLED`, `SSE-KMS`, `SSE-S3`. Default value: `DISABLED`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:glue/TriggerAction:TriggerAction": { "properties": { "arguments": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Arguments to be passed to the job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.\n" }, "crawlerName": { "type": "string", "description": "The name of the crawler to be executed. Conflicts with `job_name`.\n" }, "jobName": { "type": "string", "description": "The name of a job to be executed. Conflicts with `crawler_name`.\n" }, "notificationProperty": { "$ref": "#/types/aws:glue/TriggerActionNotificationProperty:TriggerActionNotificationProperty", "description": "Specifies configuration properties of a job run notification. See Notification Property details below.\n" }, "securityConfiguration": { "type": "string", "description": "The name of the Security Configuration structure to be used with this action.\n" }, "timeout": { "type": "integer", "description": "The job run timeout in minutes. It overrides the timeout value of the job.\n" } }, "type": "object" }, "aws:glue/TriggerActionNotificationProperty:TriggerActionNotificationProperty": { "properties": { "notifyDelayAfter": { "type": "integer", "description": "After a job run starts, the number of minutes to wait before sending a job run delay notification.\n" } }, "type": "object" }, "aws:glue/TriggerEventBatchingCondition:TriggerEventBatchingCondition": { "properties": { "batchSize": { "type": "integer", "description": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.\n" }, "batchWindow": { "type": "integer", "description": "Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received. Default value is `900`.\n" } }, "type": "object", "required": [ "batchSize" ] }, "aws:glue/TriggerPredicate:TriggerPredicate": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/aws:glue/TriggerPredicateCondition:TriggerPredicateCondition" }, "description": "A list of the conditions that determine when the trigger will fire. See Conditions.\n" }, "logical": { "type": "string", "description": "How to handle multiple conditions. Defaults to `AND`. Valid values are `AND` or `ANY`.\n" } }, "type": "object", "required": [ "conditions" ] }, "aws:glue/TriggerPredicateCondition:TriggerPredicateCondition": { "properties": { "crawlState": { "type": "string", "description": "The condition crawl state. Currently, the values supported are `RUNNING`, `SUCCEEDED`, `CANCELLED`, and `FAILED`. If this is specified, `crawler_name` must also be specified. Conflicts with `state`.\n" }, "crawlerName": { "type": "string", "description": "The name of the crawler to watch. If this is specified, `crawl_state` must also be specified. Conflicts with `job_name`.\n" }, "jobName": { "type": "string", "description": "The name of the job to watch. If this is specified, `state` must also be specified. Conflicts with `crawler_name`.\n" }, "logicalOperator": { "type": "string", "description": "A logical operator. Defaults to `EQUALS`.\n" }, "state": { "type": "string", "description": "The condition job state. Currently, the values supported are `SUCCEEDED`, `STOPPED`, `TIMEOUT` and `FAILED`. If this is specified, `job_name` must also be specified. Conflicts with `crawler_state`.\n" } }, "type": "object" }, "aws:glue/UserDefinedFunctionResourceUri:UserDefinedFunctionResourceUri": { "properties": { "resourceType": { "type": "string", "description": "The type of the resource. can be one of `JAR`, `FILE`, and `ARCHIVE`.\n" }, "uri": { "type": "string", "description": "The URI for accessing the resource.\n" } }, "type": "object", "required": [ "resourceType", "uri" ] }, "aws:glue/getCatalogTablePartitionIndex:getCatalogTablePartitionIndex": { "properties": { "indexName": { "type": "string", "description": "Name of the partition index.\n" }, "indexStatus": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Keys for the partition index.\n" } }, "type": "object", "required": [ "indexName", "indexStatus", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTablePartitionKey:getCatalogTablePartitionKey": { "properties": { "comment": { "type": "string", "description": "Free-form text comment.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "type": { "type": "string", "description": "Datatype of data in the Column.\n" } }, "type": "object", "required": [ "comment", "name", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptor:getCatalogTableStorageDescriptor": { "properties": { "additionalLocations": { "type": "array", "items": { "type": "string" }, "description": "List of locations that point to the path where a Delta table is located\n" }, "bucketColumns": { "type": "array", "items": { "type": "string" }, "description": "List of reducer grouping columns, clustering columns, and bucketing columns in the table.\n" }, "columns": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorColumn:getCatalogTableStorageDescriptorColumn" }, "description": "Configuration block for columns in the table. See `columns` below.\n" }, "compressed": { "type": "boolean", "description": "Whether the data in the table is compressed.\n" }, "inputFormat": { "type": "string", "description": "Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.\n" }, "location": { "type": "string", "description": "Physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.\n" }, "numberOfBuckets": { "type": "integer", "description": "Is if the table contains any dimension columns.\n" }, "outputFormat": { "type": "string", "description": "Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of initialization parameters for the SerDe, in key-value form.\n" }, "schemaReferences": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorSchemaReference:getCatalogTableStorageDescriptorSchemaReference" }, "description": "Object that references a schema stored in the AWS Glue Schema Registry. See `schema_reference` below.\n" }, "serDeInfos": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorSerDeInfo:getCatalogTableStorageDescriptorSerDeInfo" }, "description": "Configuration block for serialization and deserialization (\"SerDe\") information. See `ser_de_info` below.\n" }, "skewedInfos": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorSkewedInfo:getCatalogTableStorageDescriptorSkewedInfo" }, "description": "Configuration block with information about values that appear very frequently in a column (skewed values). See `skewed_info` below.\n" }, "sortColumns": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorSortColumn:getCatalogTableStorageDescriptorSortColumn" }, "description": "Configuration block for the sort order of each bucket in the table. See `sort_columns` below.\n" }, "storedAsSubDirectories": { "type": "boolean", "description": "Whether the table data is stored in subdirectories.\n" } }, "type": "object", "required": [ "additionalLocations", "bucketColumns", "columns", "compressed", "inputFormat", "location", "numberOfBuckets", "outputFormat", "parameters", "schemaReferences", "serDeInfos", "skewedInfos", "sortColumns", "storedAsSubDirectories" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorColumn:getCatalogTableStorageDescriptorColumn": { "properties": { "comment": { "type": "string", "description": "Free-form text comment.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of initialization parameters for the SerDe, in key-value form.\n" }, "type": { "type": "string", "description": "Datatype of data in the Column.\n" } }, "type": "object", "required": [ "comment", "name", "parameters", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorSchemaReference:getCatalogTableStorageDescriptorSchemaReference": { "properties": { "schemaIds": { "type": "array", "items": { "$ref": "#/types/aws:glue/getCatalogTableStorageDescriptorSchemaReferenceSchemaId:getCatalogTableStorageDescriptorSchemaReferenceSchemaId" }, "description": "Configuration block that contains schema identity fields. See `schema_id` below.\n" }, "schemaVersionId": { "type": "string", "description": "Unique ID assigned to a version of the schema.\n" }, "schemaVersionNumber": { "type": "integer", "description": "Version number of the schema.\n" } }, "type": "object", "required": [ "schemaIds", "schemaVersionId", "schemaVersionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorSchemaReferenceSchemaId:getCatalogTableStorageDescriptorSchemaReferenceSchemaId": { "properties": { "registryName": { "type": "string", "description": "Name of the schema registry that contains the schema.\n" }, "schemaArn": { "type": "string", "description": "ARN of the schema.\n" }, "schemaName": { "type": "string", "description": "Name of the schema.\n" } }, "type": "object", "required": [ "registryName", "schemaArn", "schemaName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorSerDeInfo:getCatalogTableStorageDescriptorSerDeInfo": { "properties": { "name": { "type": "string", "description": "Name of the table.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of initialization parameters for the SerDe, in key-value form.\n" }, "serializationLibrary": { "type": "string", "description": "Usually the class that implements the SerDe. An example is `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.\n" } }, "type": "object", "required": [ "name", "parameters", "serializationLibrary" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorSkewedInfo:getCatalogTableStorageDescriptorSkewedInfo": { "properties": { "skewedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "List of names of columns that contain skewed values.\n" }, "skewedColumnValueLocationMaps": { "type": "object", "additionalProperties": { "type": "string" }, "description": "List of values that appear so frequently as to be considered skewed.\n" }, "skewedColumnValues": { "type": "array", "items": { "type": "string" }, "description": "Map of skewed values to the columns that contain them.\n" } }, "type": "object", "required": [ "skewedColumnNames", "skewedColumnValueLocationMaps", "skewedColumnValues" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableStorageDescriptorSortColumn:getCatalogTableStorageDescriptorSortColumn": { "properties": { "column": { "type": "string", "description": "Name of the column.\n" }, "sortOrder": { "type": "integer", "description": "Whether the column is sorted in ascending (`1`) or descending order (`0`).\n" } }, "type": "object", "required": [ "column", "sortOrder" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getCatalogTableTargetTable:getCatalogTableTargetTable": { "properties": { "catalogId": { "type": "string", "description": "ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.\n" }, "databaseName": { "type": "string", "description": "Name of the metadata database where the table metadata resides.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "region": { "type": "string", "description": "Region of the target table.\n" } }, "type": "object", "required": [ "catalogId", "databaseName", "name", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getConnectionPhysicalConnectionRequirement:getConnectionPhysicalConnectionRequirement": { "properties": { "availabilityZone": { "type": "string" }, "securityGroupIdLists": { "type": "array", "items": { "type": "string" } }, "subnetId": { "type": "string" } }, "type": "object", "required": [ "availabilityZone", "securityGroupIdLists", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getDataCatalogEncryptionSettingsDataCatalogEncryptionSetting:getDataCatalogEncryptionSettingsDataCatalogEncryptionSetting": { "properties": { "connectionPasswordEncryptions": { "type": "array", "items": { "$ref": "#/types/aws:glue/getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingConnectionPasswordEncryption:getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingConnectionPasswordEncryption" }, "description": "When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. see Connection Password Encryption.\n" }, "encryptionAtRests": { "type": "array", "items": { "$ref": "#/types/aws:glue/getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingEncryptionAtRest:getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingEncryptionAtRest" }, "description": "Encryption-at-rest configuration for the Data Catalog. see Encryption At Rest.\n" } }, "type": "object", "required": [ "connectionPasswordEncryptions", "encryptionAtRests" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingConnectionPasswordEncryption:getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingConnectionPasswordEncryption": { "properties": { "awsKmsKeyId": { "type": "string", "description": "KMS key ARN that is used to encrypt the connection password.\n" }, "returnConnectionPasswordEncrypted": { "type": "boolean", "description": "When set to `true`, passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently of the catalog encryption.\n" } }, "type": "object", "required": [ "awsKmsKeyId", "returnConnectionPasswordEncrypted" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingEncryptionAtRest:getDataCatalogEncryptionSettingsDataCatalogEncryptionSettingEncryptionAtRest": { "properties": { "catalogEncryptionMode": { "type": "string", "description": "The encryption-at-rest mode for encrypting Data Catalog data.\n" }, "catalogEncryptionServiceRole": { "type": "string", "description": "The ARN of the AWS IAM role used for accessing encrypted Data Catalog data.\n" }, "sseAwsKmsKeyId": { "type": "string", "description": "ARN of the AWS KMS key to use for encryption at rest.\n" } }, "type": "object", "required": [ "catalogEncryptionMode", "catalogEncryptionServiceRole", "sseAwsKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:glue/getScriptDagEdge:getScriptDagEdge": { "properties": { "source": { "type": "string", "description": "ID of the node at which the edge starts.\n" }, "target": { "type": "string", "description": "ID of the node at which the edge ends.\n" }, "targetParameter": { "type": "string", "description": "Target of the edge.\n" } }, "type": "object", "required": [ "source", "target" ] }, "aws:glue/getScriptDagNode:getScriptDagNode": { "properties": { "args": { "type": "array", "items": { "$ref": "#/types/aws:glue/getScriptDagNodeArg:getScriptDagNodeArg" }, "description": "Nested configuration an argument or property of a node. Defined below.\n" }, "id": { "type": "string", "description": "Node identifier that is unique within the node's graph.\n" }, "lineNumber": { "type": "integer", "description": "Line number of the node.\n" }, "nodeType": { "type": "string", "description": "Type of node this is.\n" } }, "type": "object", "required": [ "args", "id", "nodeType" ] }, "aws:glue/getScriptDagNodeArg:getScriptDagNodeArg": { "properties": { "name": { "type": "string", "description": "Name of the argument or property.\n" }, "param": { "type": "boolean", "description": "Boolean if the value is used as a parameter. Defaults to `false`.\n" }, "value": { "type": "string", "description": "Value of the argument or property.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:grafana/WorkspaceNetworkAccessControl:WorkspaceNetworkAccessControl": { "properties": { "prefixListIds": { "type": "array", "items": { "type": "string" }, "description": "An array of prefix list IDs.\n" }, "vpceIds": { "type": "array", "items": { "type": "string" }, "description": "An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.\n" } }, "type": "object", "required": [ "prefixListIds", "vpceIds" ] }, "aws:grafana/WorkspaceVpcConfiguration:WorkspaceVpcConfiguration": { "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.\n" }, "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.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds" ] }, "aws:guardduty/DetectorDatasources:DetectorDatasources": { "properties": { "kubernetes": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesKubernetes:DetectorDatasourcesKubernetes", "description": "Configures [Kubernetes protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html).\nSee Kubernetes and Kubernetes Audit Logs below for more details.\n" }, "malwareProtection": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesMalwareProtection:DetectorDatasourcesMalwareProtection", "description": "Configures [Malware Protection](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection.html).\nSee Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.\n" }, "s3Logs": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesS3Logs:DetectorDatasourcesS3Logs", "description": "Configures [S3 protection](https://docs.aws.amazon.com/guardduty/latest/ug/s3-protection.html).\nSee S3 Logs below for more details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kubernetes", "malwareProtection", "s3Logs" ] } } }, "aws:guardduty/DetectorDatasourcesKubernetes:DetectorDatasourcesKubernetes": { "properties": { "auditLogs": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesKubernetesAuditLogs:DetectorDatasourcesKubernetesAuditLogs", "description": "Configures Kubernetes audit logs as a data source for [Kubernetes protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html).\nSee Kubernetes Audit Logs below for more details.\n" } }, "type": "object", "required": [ "auditLogs" ] }, "aws:guardduty/DetectorDatasourcesKubernetesAuditLogs:DetectorDatasourcesKubernetesAuditLogs": { "properties": { "enable": { "type": "boolean", "description": "If true, enables Kubernetes audit logs as a data source for [Kubernetes protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html).\nDefaults to `true`.\n" } }, "type": "object", "required": [ "enable" ] }, "aws:guardduty/DetectorDatasourcesMalwareProtection:DetectorDatasourcesMalwareProtection": { "properties": { "scanEc2InstanceWithFindings": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings:DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings", "description": "Configure whether [Malware Protection](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection.html) is enabled as data source for EC2 instances with findings for the detector.\nSee Scan EC2 instance with findings below for more details.\n" } }, "type": "object", "required": [ "scanEc2InstanceWithFindings" ] }, "aws:guardduty/DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings:DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings": { "properties": { "ebsVolumes": { "$ref": "#/types/aws:guardduty/DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes:DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes", "description": "Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings.\nSee EBS volumes below for more details.\n" } }, "type": "object", "required": [ "ebsVolumes" ] }, "aws:guardduty/DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes:DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes": { "properties": { "enable": { "type": "boolean", "description": "If true, enables [Malware Protection](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection.html) as data source for the detector.\nDefaults to `true`.\n" } }, "type": "object", "required": [ "enable" ] }, "aws:guardduty/DetectorDatasourcesS3Logs:DetectorDatasourcesS3Logs": { "properties": { "enable": { "type": "boolean", "description": "If true, enables [S3 protection](https://docs.aws.amazon.com/guardduty/latest/ug/s3-protection.html).\nDefaults to `true`.\n" } }, "type": "object", "required": [ "enable" ] }, "aws:guardduty/DetectorFeatureAdditionalConfiguration:DetectorFeatureAdditionalConfiguration": { "properties": { "name": { "type": "string", "description": "The name of the additional configuration for a feature. Valid values: `EKS_ADDON_MANAGEMENT`, `ECS_FARGATE_AGENT_MANAGEMENT`, `EC2_AGENT_MANAGEMENT`. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorAdditionalConfiguration.html) for the current list of supported values.\n", "willReplaceOnChanges": true }, "status": { "type": "string", "description": "The status of the additional configuration. Valid values: `ENABLED`, `DISABLED`.\n" } }, "type": "object", "required": [ "name", "status" ] }, "aws:guardduty/FilterFindingCriteria:FilterFindingCriteria": { "properties": { "criterions": { "type": "array", "items": { "$ref": "#/types/aws:guardduty/FilterFindingCriteriaCriterion:FilterFindingCriteriaCriterion" } } }, "type": "object", "required": [ "criterions" ] }, "aws:guardduty/FilterFindingCriteriaCriterion:FilterFindingCriteriaCriterion": { "properties": { "equals": { "type": "array", "items": { "type": "string" }, "description": "List of string values to be evaluated.\n" }, "field": { "type": "string", "description": "The name of the field to be evaluated. The full list of field names can be found in [AWS documentation](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html#filter_criteria).\n" }, "greaterThan": { "type": "string", "description": "A value to be evaluated. Accepts either an integer or a date in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" }, "greaterThanOrEqual": { "type": "string", "description": "A value to be evaluated. Accepts either an integer or a date in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" }, "lessThan": { "type": "string", "description": "A value to be evaluated. Accepts either an integer or a date in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" }, "lessThanOrEqual": { "type": "string", "description": "A value to be evaluated. Accepts either an integer or a date in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).\n" }, "notEquals": { "type": "array", "items": { "type": "string" }, "description": "List of string values to be evaluated.\n" } }, "type": "object", "required": [ "field" ] }, "aws:guardduty/MalwareProtectionPlanAction:MalwareProtectionPlanAction": { "properties": { "taggings": { "type": "array", "items": { "$ref": "#/types/aws:guardduty/MalwareProtectionPlanActionTagging:MalwareProtectionPlanActionTagging" }, "description": "Indicates whether the scanned S3 object will have tags about the scan result. See `tagging` below.\n" } }, "type": "object", "required": [ "taggings" ] }, "aws:guardduty/MalwareProtectionPlanActionTagging:MalwareProtectionPlanActionTagging": { "properties": { "status": { "type": "string", "description": "Indicates whether or not the tags will added. Valid values are `DISABLED` and `ENABLED`. Defaults to `DISABLED`\n" } }, "type": "object", "required": [ "status" ] }, "aws:guardduty/MalwareProtectionPlanProtectedResource:MalwareProtectionPlanProtectedResource": { "properties": { "s3Bucket": { "$ref": "#/types/aws:guardduty/MalwareProtectionPlanProtectedResourceS3Bucket:MalwareProtectionPlanProtectedResourceS3Bucket", "description": "Information about the protected S3 bucket resource. See `s3_bucket` below.\n" } }, "type": "object" }, "aws:guardduty/MalwareProtectionPlanProtectedResourceS3Bucket:MalwareProtectionPlanProtectedResourceS3Bucket": { "properties": { "bucketName": { "type": "string", "description": "Name of the S3 bucket.\n" }, "objectPrefixes": { "type": "array", "items": { "type": "string" }, "description": "The list of object prefixes that specify the S3 objects that will be scanned.\n" } }, "type": "object", "required": [ "bucketName" ], "language": { "nodejs": { "requiredOutputs": [ "bucketName", "objectPrefixes" ] } } }, "aws:guardduty/MemberDetectorFeatureAdditionalConfiguration:MemberDetectorFeatureAdditionalConfiguration": { "properties": { "name": { "type": "string", "description": "The name of the additional configuration. Valid values: `EKS_ADDON_MANAGEMENT`, `ECS_FARGATE_AGENT_MANAGEMENT`.\n" }, "status": { "type": "string", "description": "The status of the additional configuration. Valid values: `ENABLED`, `DISABLED`.\n" } }, "type": "object", "required": [ "name", "status" ] }, "aws:guardduty/OrganizationConfigurationDatasources:OrganizationConfigurationDatasources": { "properties": { "kubernetes": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesKubernetes:OrganizationConfigurationDatasourcesKubernetes", "description": "Enable Kubernetes Audit Logs Monitoring automatically for new member accounts.\n" }, "malwareProtection": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtection:OrganizationConfigurationDatasourcesMalwareProtection", "description": "Enable Malware Protection automatically for new member accounts.\n" }, "s3Logs": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesS3Logs:OrganizationConfigurationDatasourcesS3Logs", "description": "Enable S3 Protection automatically for new member accounts.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kubernetes", "malwareProtection", "s3Logs" ] } } }, "aws:guardduty/OrganizationConfigurationDatasourcesKubernetes:OrganizationConfigurationDatasourcesKubernetes": { "properties": { "auditLogs": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesKubernetesAuditLogs:OrganizationConfigurationDatasourcesKubernetesAuditLogs", "description": "Enable Kubernetes Audit Logs Monitoring automatically for new member accounts. [Kubernetes protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html).\nSee Kubernetes Audit Logs below for more details.\n" } }, "type": "object", "required": [ "auditLogs" ] }, "aws:guardduty/OrganizationConfigurationDatasourcesKubernetesAuditLogs:OrganizationConfigurationDatasourcesKubernetesAuditLogs": { "properties": { "enable": { "type": "boolean", "description": "If true, enables Kubernetes audit logs as a data source for [Kubernetes protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html).\nDefaults to `true`.\n" } }, "type": "object", "required": [ "enable" ] }, "aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtection:OrganizationConfigurationDatasourcesMalwareProtection": { "properties": { "scanEc2InstanceWithFindings": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindings:OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindings", "description": "Configure whether [Malware Protection](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection.html) for EC2 instances with findings should be auto-enabled for new members joining the organization.\nSee Scan EC2 instance with findings below for more details.\n" } }, "type": "object", "required": [ "scanEc2InstanceWithFindings" ] }, "aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindings:OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindings": { "properties": { "ebsVolumes": { "$ref": "#/types/aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes:OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes", "description": "Configure whether scanning EBS volumes should be auto-enabled for new members joining the organization\nSee EBS volumes below for more details.\n" } }, "type": "object", "required": [ "ebsVolumes" ] }, "aws:guardduty/OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes:OrganizationConfigurationDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes": { "properties": { "autoEnable": { "type": "boolean", "description": "If true, enables [Malware Protection](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection.html) for all new accounts joining the organization.\nDefaults to `true`.\n" } }, "type": "object", "required": [ "autoEnable" ] }, "aws:guardduty/OrganizationConfigurationDatasourcesS3Logs:OrganizationConfigurationDatasourcesS3Logs": { "properties": { "autoEnable": { "type": "boolean", "description": "Set to `true` if you want S3 data event logs to be automatically enabled for new members of the organization. Default: `false`\n" } }, "type": "object", "required": [ "autoEnable" ] }, "aws:guardduty/OrganizationConfigurationFeatureAdditionalConfiguration:OrganizationConfigurationFeatureAdditionalConfiguration": { "properties": { "autoEnable": { "type": "string", "description": "The status of the additional configuration that will be configured for the organization. Valid values: `NEW`, `ALL`, `NONE`.\n" }, "name": { "type": "string", "description": "The name of the additional configuration for a feature that will be configured for the organization. Valid values: `EKS_ADDON_MANAGEMENT`, `ECS_FARGATE_AGENT_MANAGEMENT`, `EC2_AGENT_MANAGEMENT`. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorAdditionalConfiguration.html) for the current list of supported values.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "autoEnable", "name" ] }, "aws:guardduty/getDetectorFeature:getDetectorFeature": { "properties": { "additionalConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:guardduty/getDetectorFeatureAdditionalConfiguration:getDetectorFeatureAdditionalConfiguration" }, "description": "Additional feature configuration.\n" }, "name": { "type": "string", "description": "The name of the detector feature.\n" }, "status": { "type": "string", "description": "Current status of the detector.\n" } }, "type": "object", "required": [ "additionalConfigurations", "name", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:guardduty/getDetectorFeatureAdditionalConfiguration:getDetectorFeatureAdditionalConfiguration": { "properties": { "name": { "type": "string", "description": "The name of the detector feature.\n" }, "status": { "type": "string", "description": "Current status of the detector.\n" } }, "type": "object", "required": [ "name", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:iam/ManagedPolicy:ManagedPolicy": { "type": "string", "enum": [ { "name": "APIGatewayServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/APIGatewayServiceRolePolicy" }, { "name": "AWSAccountActivityAccess", "value": "arn:aws:iam::aws:policy/AWSAccountActivityAccess" }, { "name": "AWSAccountManagementFullAccess", "value": "arn:aws:iam::aws:policy/AWSAccountManagementFullAccess" }, { "name": "AWSAccountManagementReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSAccountManagementReadOnlyAccess" }, { "name": "AWSAccountUsageReportAccess", "value": "arn:aws:iam::aws:policy/AWSAccountUsageReportAccess" }, { "name": "AWSAgentlessDiscoveryService", "value": "arn:aws:iam::aws:policy/AWSAgentlessDiscoveryService" }, { "name": "AWSAppFabricFullAccess", "value": "arn:aws:iam::aws:policy/AWSAppFabricFullAccess" }, { "name": "AWSAppFabricReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSAppFabricReadOnlyAccess" }, { "name": "AWSAppFabricServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAppFabricServiceRolePolicy" }, { "name": "AWSAppMeshEnvoyAccess", "value": "arn:aws:iam::aws:policy/AWSAppMeshEnvoyAccess" }, { "name": "AWSAppMeshFullAccess", "value": "arn:aws:iam::aws:policy/AWSAppMeshFullAccess" }, { "name": "AWSAppMeshPreviewEnvoyAccess", "value": "arn:aws:iam::aws:policy/AWSAppMeshPreviewEnvoyAccess" }, { "name": "AWSAppMeshPreviewServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAppMeshPreviewServiceRolePolicy" }, { "name": "AWSAppMeshReadOnly", "value": "arn:aws:iam::aws:policy/AWSAppMeshReadOnly" }, { "name": "AWSAppMeshServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAppMeshServiceRolePolicy" }, { "name": "AWSAppRunnerFullAccess", "value": "arn:aws:iam::aws:policy/AWSAppRunnerFullAccess" }, { "name": "AWSAppRunnerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSAppRunnerReadOnlyAccess" }, { "name": "AWSAppRunnerServicePolicyForECRAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSAppRunnerServicePolicyForECRAccess" }, { "name": "AWSAppSyncAdministrator", "value": "arn:aws:iam::aws:policy/AWSAppSyncAdministrator" }, { "name": "AWSAppSyncInvokeFullAccess", "value": "arn:aws:iam::aws:policy/AWSAppSyncInvokeFullAccess" }, { "name": "AWSAppSyncPushToCloudWatchLogs", "value": "arn:aws:iam::aws:policy/service-role/AWSAppSyncPushToCloudWatchLogs" }, { "name": "AWSAppSyncSchemaAuthor", "value": "arn:aws:iam::aws:policy/AWSAppSyncSchemaAuthor" }, { "name": "AWSAppSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAppSyncServiceRolePolicy" }, { "name": "AWSApplicationAutoScalingCustomResourcePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoScalingCustomResourcePolicy" }, { "name": "AWSApplicationAutoscalingAppStreamFleetPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingAppStreamFleetPolicy" }, { "name": "AWSApplicationAutoscalingCassandraTablePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingCassandraTablePolicy" }, { "name": "AWSApplicationAutoscalingComprehendEndpointPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingComprehendEndpointPolicy" }, { "name": "AWSApplicationAutoscalingDynamoDBTablePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingDynamoDBTablePolicy" }, { "name": "AWSApplicationAutoscalingEC2SpotFleetRequestPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingEC2SpotFleetRequestPolicy" }, { "name": "AWSApplicationAutoscalingECSServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingECSServicePolicy" }, { "name": "AWSApplicationAutoscalingEMRInstanceGroupPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingEMRInstanceGroupPolicy" }, { "name": "AWSApplicationAutoscalingElastiCacheRGPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingElastiCacheRGPolicy" }, { "name": "AWSApplicationAutoscalingKafkaClusterPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingKafkaClusterPolicy" }, { "name": "AWSApplicationAutoscalingLambdaConcurrencyPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingLambdaConcurrencyPolicy" }, { "name": "AWSApplicationAutoscalingNeptuneClusterPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingNeptuneClusterPolicy" }, { "name": "AWSApplicationAutoscalingRDSClusterPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingRDSClusterPolicy" }, { "name": "AWSApplicationAutoscalingSageMakerEndpointPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationAutoscalingSageMakerEndpointPolicy" }, { "name": "AWSApplicationDiscoveryAgentAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationDiscoveryAgentAccess" }, { "name": "AWSApplicationDiscoveryAgentlessCollectorAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationDiscoveryAgentlessCollectorAccess" }, { "name": "AWSApplicationDiscoveryServiceFullAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationDiscoveryServiceFullAccess" }, { "name": "AWSApplicationMigrationAgentInstallationPolicy", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationAgentInstallationPolicy" }, { "name": "AWSApplicationMigrationAgentPolicy", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationAgentPolicy" }, { "name": "AWSApplicationMigrationAgentPolicy_v2", "value": "arn:aws:iam::aws:policy/service-role/AWSApplicationMigrationAgentPolicy_v2" }, { "name": "AWSApplicationMigrationConversionServerPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSApplicationMigrationConversionServerPolicy" }, { "name": "AWSApplicationMigrationEC2Access", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationEC2Access" }, { "name": "AWSApplicationMigrationFullAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationFullAccess" }, { "name": "AWSApplicationMigrationMGHAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSApplicationMigrationMGHAccess" }, { "name": "AWSApplicationMigrationReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationReadOnlyAccess" }, { "name": "AWSApplicationMigrationReplicationServerPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSApplicationMigrationReplicationServerPolicy" }, { "name": "AWSApplicationMigrationSSMAccess", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationSSMAccess" }, { "name": "AWSApplicationMigrationServiceEc2InstancePolicy", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationServiceEc2InstancePolicy" }, { "name": "AWSApplicationMigrationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSApplicationMigrationServiceRolePolicy" }, { "name": "AWSApplicationMigrationVCenterClientPolicy", "value": "arn:aws:iam::aws:policy/AWSApplicationMigrationVCenterClientPolicy" }, { "name": "AWSArtifactAccountSync", "value": "arn:aws:iam::aws:policy/service-role/AWSArtifactAccountSync" }, { "name": "AWSArtifactReportsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSArtifactReportsReadOnlyAccess" }, { "name": "AWSArtifactServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSArtifactServiceRolePolicy" }, { "name": "AWSAuditManagerAdministratorAccess", "value": "arn:aws:iam::aws:policy/AWSAuditManagerAdministratorAccess" }, { "name": "AWSAuditManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAuditManagerServiceRolePolicy" }, { "name": "AWSAutoScalingPlansEC2AutoScalingPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSAutoScalingPlansEC2AutoScalingPolicy" }, { "name": "AWSBackupAuditAccess", "value": "arn:aws:iam::aws:policy/AWSBackupAuditAccess" }, { "name": "AWSBackupDataTransferAccess", "value": "arn:aws:iam::aws:policy/AWSBackupDataTransferAccess" }, { "name": "AWSBackupFullAccess", "value": "arn:aws:iam::aws:policy/AWSBackupFullAccess" }, { "name": "AWSBackupGatewayServiceRolePolicyForVirtualMachineMetadataSync", "value": "arn:aws:iam::aws:policy/service-role/AWSBackupGatewayServiceRolePolicyForVirtualMachineMetadataSync" }, { "name": "AWSBackupOperatorAccess", "value": "arn:aws:iam::aws:policy/AWSBackupOperatorAccess" }, { "name": "AWSBackupOrganizationAdminAccess", "value": "arn:aws:iam::aws:policy/AWSBackupOrganizationAdminAccess" }, { "name": "AWSBackupRestoreAccessForSAPHANA", "value": "arn:aws:iam::aws:policy/AWSBackupRestoreAccessForSAPHANA" }, { "name": "AWSBackupServiceLinkedRolePolicyForBackup", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSBackupServiceLinkedRolePolicyForBackup" }, { "name": "AWSBackupServiceLinkedRolePolicyForBackupTest", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSBackupServiceLinkedRolePolicyForBackupTest" }, { "name": "AWSBackupServiceRolePolicyForBackup", "value": "arn:aws:iam::aws:policy/service-role/AWSBackupServiceRolePolicyForBackup" }, { "name": "AWSBackupServiceRolePolicyForRestores", "value": "arn:aws:iam::aws:policy/service-role/AWSBackupServiceRolePolicyForRestores" }, { "name": "AWSBackupServiceRolePolicyForS3Backup", "value": "arn:aws:iam::aws:policy/AWSBackupServiceRolePolicyForS3Backup" }, { "name": "AWSBackupServiceRolePolicyForS3Restore", "value": "arn:aws:iam::aws:policy/AWSBackupServiceRolePolicyForS3Restore" }, { "name": "AWSBatchFullAccess", "value": "arn:aws:iam::aws:policy/AWSBatchFullAccess" }, { "name": "AWSBatchServiceEventTargetRole", "value": "arn:aws:iam::aws:policy/service-role/AWSBatchServiceEventTargetRole" }, { "name": "AWSBatchServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSBatchServiceRole" }, { "name": "AWSBillingConductorFullAccess", "value": "arn:aws:iam::aws:policy/AWSBillingConductorFullAccess" }, { "name": "AWSBillingConductorReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSBillingConductorReadOnlyAccess" }, { "name": "AWSBillingReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSBillingReadOnlyAccess" }, { "name": "AWSBudgetsActionsWithAWSResourceControlAccess", "value": "arn:aws:iam::aws:policy/AWSBudgetsActionsWithAWSResourceControlAccess" }, { "name": "AWSBudgetsActions_RolePolicyForResourceAdministrationWithSSM", "value": "arn:aws:iam::aws:policy/AWSBudgetsActions_RolePolicyForResourceAdministrationWithSSM" }, { "name": "AWSBudgetsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSBudgetsReadOnlyAccess" }, { "name": "AWSBugBustFullAccess", "value": "arn:aws:iam::aws:policy/AWSBugBustFullAccess" }, { "name": "AWSBugBustPlayerAccess", "value": "arn:aws:iam::aws:policy/AWSBugBustPlayerAccess" }, { "name": "AWSBugBustServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSBugBustServiceRolePolicy" }, { "name": "AWSCertificateManagerFullAccess", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerFullAccess" }, { "name": "AWSCertificateManagerPrivateCAAuditor", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerPrivateCAAuditor" }, { "name": "AWSCertificateManagerPrivateCAFullAccess", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerPrivateCAFullAccess" }, { "name": "AWSCertificateManagerPrivateCAPrivilegedUser", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerPrivateCAPrivilegedUser" }, { "name": "AWSCertificateManagerPrivateCAReadOnly", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerPrivateCAReadOnly" }, { "name": "AWSCertificateManagerPrivateCAUser", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerPrivateCAUser" }, { "name": "AWSCertificateManagerReadOnly", "value": "arn:aws:iam::aws:policy/AWSCertificateManagerReadOnly" }, { "name": "AWSChatbotServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSChatbotServiceLinkedRolePolicy" }, { "name": "AWSCleanRoomsFullAccess", "value": "arn:aws:iam::aws:policy/AWSCleanRoomsFullAccess" }, { "name": "AWSCleanRoomsFullAccessNoQuerying", "value": "arn:aws:iam::aws:policy/AWSCleanRoomsFullAccessNoQuerying" }, { "name": "AWSCleanRoomsMLFullAccess", "value": "arn:aws:iam::aws:policy/AWSCleanRoomsMLFullAccess" }, { "name": "AWSCleanRoomsMLReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCleanRoomsMLReadOnlyAccess" }, { "name": "AWSCleanRoomsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCleanRoomsReadOnlyAccess" }, { "name": "AWSCloud9Administrator", "value": "arn:aws:iam::aws:policy/AWSCloud9Administrator" }, { "name": "AWSCloud9EnvironmentMember", "value": "arn:aws:iam::aws:policy/AWSCloud9EnvironmentMember" }, { "name": "AWSCloud9SSMInstanceProfile", "value": "arn:aws:iam::aws:policy/AWSCloud9SSMInstanceProfile" }, { "name": "AWSCloud9ServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSCloud9ServiceRolePolicy" }, { "name": "AWSCloud9User", "value": "arn:aws:iam::aws:policy/AWSCloud9User" }, { "name": "AWSCloudFormationFullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudFormationFullAccess" }, { "name": "AWSCloudFormationReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCloudFormationReadOnlyAccess" }, { "name": "AWSCloudFrontLogger", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSCloudFrontLogger" }, { "name": "AWSCloudHSMFullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudHSMFullAccess" }, { "name": "AWSCloudHSMReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCloudHSMReadOnlyAccess" }, { "name": "AWSCloudHSMRole", "value": "arn:aws:iam::aws:policy/service-role/AWSCloudHSMRole" }, { "name": "AWSCloudTrailFullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudTrailFullAccess", "deprecationMessage": "No longer supported. Use CloudTrail_FullAccess instead." }, { "name": "AWSCloudTrailReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCloudTrailReadOnlyAccess", "deprecationMessage": "No longer supported. Use CloudTrail_ReadOnlyAccess instead." }, { "name": "AWSCloudWatchLambdaInsightsExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/AWSCloudWatchLambdaInsightsExecutionRolePolicy", "deprecationMessage": "No longer supported. Use CloudWatchLambdaInsightsExecutionRolePolicy instead." }, { "name": "AWSCloudMapDiscoverInstanceAccess", "value": "arn:aws:iam::aws:policy/AWSCloudMapDiscoverInstanceAccess" }, { "name": "AWSCloudMapFullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudMapFullAccess" }, { "name": "AWSCloudMapReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCloudMapReadOnlyAccess" }, { "name": "AWSCloudMapRegisterInstanceAccess", "value": "arn:aws:iam::aws:policy/AWSCloudMapRegisterInstanceAccess" }, { "name": "AWSCloudShellFullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudShellFullAccess" }, { "name": "CloudTrail_FullAccess", "value": "arn:aws:iam::aws:policy/AWSCloudTrail_FullAccess" }, { "name": "CloudTrail_ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCloudTrail_ReadOnlyAccess" }, { "name": "AWSCloudWatchAlarms_ActionSSMIncidentsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSCloudWatchAlarms_ActionSSMIncidentsServiceRolePolicy" }, { "name": "AWSCodeArtifactAdminAccess", "value": "arn:aws:iam::aws:policy/AWSCodeArtifactAdminAccess" }, { "name": "AWSCodeArtifactReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCodeArtifactReadOnlyAccess" }, { "name": "AWSCodeBuildAdminAccess", "value": "arn:aws:iam::aws:policy/AWSCodeBuildAdminAccess" }, { "name": "AWSCodeBuildDeveloperAccess", "value": "arn:aws:iam::aws:policy/AWSCodeBuildDeveloperAccess" }, { "name": "AWSCodeBuildReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCodeBuildReadOnlyAccess" }, { "name": "AWSCodeCommitFullAccess", "value": "arn:aws:iam::aws:policy/AWSCodeCommitFullAccess" }, { "name": "AWSCodeCommitPowerUser", "value": "arn:aws:iam::aws:policy/AWSCodeCommitPowerUser" }, { "name": "AWSCodeCommitReadOnly", "value": "arn:aws:iam::aws:policy/AWSCodeCommitReadOnly" }, { "name": "AWSCodeDeployDeployerAccess", "value": "arn:aws:iam::aws:policy/AWSCodeDeployDeployerAccess" }, { "name": "AWSCodeDeployFullAccess", "value": "arn:aws:iam::aws:policy/AWSCodeDeployFullAccess" }, { "name": "AWSCodeDeployReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCodeDeployReadOnlyAccess" }, { "name": "AWSCodeDeployRole", "value": "arn:aws:iam::aws:policy/service-role/AWSCodeDeployRole" }, { "name": "AWSCodeDeployRoleForCloudFormation", "value": "arn:aws:iam::aws:policy/service-role/AWSCodeDeployRoleForCloudFormation" }, { "name": "AWSCodeDeployRoleForECS", "value": "arn:aws:iam::aws:policy/AWSCodeDeployRoleForECS" }, { "name": "AWSCodeDeployRoleForECSLimited", "value": "arn:aws:iam::aws:policy/AWSCodeDeployRoleForECSLimited" }, { "name": "AWSCodeDeployRoleForLambda", "value": "arn:aws:iam::aws:policy/service-role/AWSCodeDeployRoleForLambda" }, { "name": "AWSCodeDeployRoleForLambdaLimited", "value": "arn:aws:iam::aws:policy/service-role/AWSCodeDeployRoleForLambdaLimited" }, { "name": "AWSCodePipelineApproverAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipelineApproverAccess" }, { "name": "AWSCodePipelineCustomActionAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipelineCustomActionAccess" }, { "name": "AWSCodePipelineFullAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipelineFullAccess", "deprecationMessage": "No longer supported. Use CodePipeline_FullAccess instead." }, { "name": "AWSCodePipelineReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipelineReadOnlyAccess", "deprecationMessage": "No longer supported. Use CodePipeline_ReadOnlyAccess instead." }, { "name": "CodePipeline_FullAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipeline_FullAccess" }, { "name": "CodePipeline_ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSCodePipeline_ReadOnlyAccess" }, { "name": "AWSCodeStarFullAccess", "value": "arn:aws:iam::aws:policy/AWSCodeStarFullAccess" }, { "name": "AWSCodeStarNotificationsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSCodeStarNotificationsServiceRolePolicy" }, { "name": "AWSCodeStarServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSCodeStarServiceRole" }, { "name": "AWS_ConfigRole", "value": "arn:aws:iam::aws:policy/service-role/AWS_ConfigRole" }, { "name": "AWSConfigRole", "value": "arn:aws:iam::aws:policy/service-role/AWSConfigRole", "deprecationMessage": "This has been deprecated in favour of `AWS_ConfigRole`" }, { "name": "AWSCompromisedKeyQuarantine", "value": "arn:aws:iam::aws:policy/AWSCompromisedKeyQuarantine" }, { "name": "AWSCompromisedKeyQuarantineV2", "value": "arn:aws:iam::aws:policy/AWSCompromisedKeyQuarantineV2" }, { "name": "AWSConfigMultiAccountSetupPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSConfigMultiAccountSetupPolicy" }, { "name": "AWSConfigRemediationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSConfigRemediationServiceRolePolicy" }, { "name": "AWSConfigRoleForOrganizations", "value": "arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations" }, { "name": "AWSConfigRulesExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSConfigRulesExecutionRole" }, { "name": "AWSConfigServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSConfigServiceRolePolicy" }, { "name": "AWSConfigUserAccess", "value": "arn:aws:iam::aws:policy/AWSConfigUserAccess" }, { "name": "AWSConnector", "value": "arn:aws:iam::aws:policy/AWSConnector" }, { "name": "AWSControlTowerAccountServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSControlTowerAccountServiceRolePolicy" }, { "name": "AWSControlTowerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSControlTowerServiceRolePolicy" }, { "name": "AWSCostAndUsageReportAutomationPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSCostAndUsageReportAutomationPolicy" }, { "name": "AWSDMSFleetAdvisorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDMSFleetAdvisorServiceRolePolicy" }, { "name": "AWSDMSServerlessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDMSServerlessServiceRolePolicy" }, { "name": "AWSDataExchangeFullAccess", "value": "arn:aws:iam::aws:policy/AWSDataExchangeFullAccess" }, { "name": "AWSDataExchangeProviderFullAccess", "value": "arn:aws:iam::aws:policy/AWSDataExchangeProviderFullAccess" }, { "name": "AWSDataExchangeReadOnly", "value": "arn:aws:iam::aws:policy/AWSDataExchangeReadOnly" }, { "name": "AWSDataExchangeSubscriberFullAccess", "value": "arn:aws:iam::aws:policy/AWSDataExchangeSubscriberFullAccess" }, { "name": "AWSDataLifecycleManagerSSMFullAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSDataLifecycleManagerSSMFullAccess" }, { "name": "AWSDataLifecycleManagerServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSDataLifecycleManagerServiceRole" }, { "name": "AWSDataLifecycleManagerServiceRoleForAMIManagement", "value": "arn:aws:iam::aws:policy/service-role/AWSDataLifecycleManagerServiceRoleForAMIManagement" }, { "name": "AWSDataPipelineRole", "value": "arn:aws:iam::aws:policy/service-role/AWSDataPipelineRole", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AWSDataPipeline_FullAccess", "value": "arn:aws:iam::aws:policy/AWSDataPipeline_FullAccess" }, { "name": "AWSDataPipeline_PowerUser", "value": "arn:aws:iam::aws:policy/AWSDataPipeline_PowerUser" }, { "name": "AWSDataSyncDiscoveryServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDataSyncDiscoveryServiceRolePolicy" }, { "name": "AWSDataSyncFullAccess", "value": "arn:aws:iam::aws:policy/AWSDataSyncFullAccess" }, { "name": "AWSDataSyncReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSDataSyncReadOnlyAccess" }, { "name": "AWSDeepLensLambdaFunctionAccessPolicy", "value": "arn:aws:iam::aws:policy/AWSDeepLensLambdaFunctionAccessPolicy" }, { "name": "AWSDeepLensServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSDeepLensServiceRolePolicy" }, { "name": "AWSDeepRacerAccountAdminAccess", "value": "arn:aws:iam::aws:policy/AWSDeepRacerAccountAdminAccess" }, { "name": "AWSDeepRacerCloudFormationAccessPolicy", "value": "arn:aws:iam::aws:policy/AWSDeepRacerCloudFormationAccessPolicy" }, { "name": "AWSDeepRacerDefaultMultiUserAccess", "value": "arn:aws:iam::aws:policy/AWSDeepRacerDefaultMultiUserAccess" }, { "name": "AWSDeepRacerFullAccess", "value": "arn:aws:iam::aws:policy/AWSDeepRacerFullAccess" }, { "name": "AWSDeepRacerRoboMakerAccessPolicy", "value": "arn:aws:iam::aws:policy/AWSDeepRacerRoboMakerAccessPolicy" }, { "name": "AWSDeepRacerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSDeepRacerServiceRolePolicy" }, { "name": "AWSDenyAll", "value": "arn:aws:iam::aws:policy/AWSDenyAll" }, { "name": "AWSDeviceFarmFullAccess", "value": "arn:aws:iam::aws:policy/AWSDeviceFarmFullAccess" }, { "name": "AWSDeviceFarmServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDeviceFarmServiceRolePolicy" }, { "name": "AWSDeviceFarmTestGridServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDeviceFarmTestGridServiceRolePolicy" }, { "name": "AWSDirectConnectFullAccess", "value": "arn:aws:iam::aws:policy/AWSDirectConnectFullAccess" }, { "name": "AWSDirectConnectReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSDirectConnectReadOnlyAccess" }, { "name": "AWSDirectConnectServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSDirectConnectServiceRolePolicy" }, { "name": "AWSDirectoryServiceFullAccess", "value": "arn:aws:iam::aws:policy/AWSDirectoryServiceFullAccess" }, { "name": "AWSDirectoryServiceReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSDirectoryServiceReadOnlyAccess" }, { "name": "AWSDiscoveryContinuousExportFirehosePolicy", "value": "arn:aws:iam::aws:policy/AWSDiscoveryContinuousExportFirehosePolicy" }, { "name": "AWSEC2CapacityReservationFleetRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSEC2CapacityReservationFleetRolePolicy" }, { "name": "AWSEC2FleetServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSEC2FleetServiceRolePolicy" }, { "name": "AWSEC2SpotFleetServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSEC2SpotFleetServiceRolePolicy" }, { "name": "AWSEC2SpotServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSEC2SpotServiceRolePolicy" }, { "name": "AWSECRPullThroughCache_ServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSECRPullThroughCache_ServiceRolePolicy" }, { "name": "AWSElasticBeanstalkCustomPlatformforEC2Role", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkCustomPlatformforEC2Role" }, { "name": "AWSElasticBeanstalkEnhancedHealth", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkEnhancedHealth" }, { "name": "AWSElasticBeanstalkFullAccess", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkFullAccess", "deprecationMessage": "This policy is deprecated. Please use the AWS managed policy AdministratorAccess-AWSElasticBeanstalk instead." }, { "name": "AWSElasticBeanstalkMaintenance", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticBeanstalkMaintenance" }, { "name": "AWSElasticBeanstalkManagedUpdatesCustomerRolePolicy", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkManagedUpdatesCustomerRolePolicy" }, { "name": "AWSElasticBeanstalkManagedUpdatesServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticBeanstalkManagedUpdatesServiceRolePolicy" }, { "name": "AWSElasticBeanstalkMulticontainerDocker", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkMulticontainerDocker" }, { "name": "AWSElasticBeanstalkReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkReadOnlyAccess", "deprecationMessage": "This policy is deprecated. Please use the AWS managed policy AWSElasticBeanstalkReadOnly instead." }, { "name": "AWSElasticBeanstalkReadOnly", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkReadOnly" }, { "name": "AWSElasticBeanstalkRoleCWL", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleCWL" }, { "name": "AWSElasticBeanstalkRoleCore", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleCore" }, { "name": "AWSElasticBeanstalkRoleECS", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleECS" }, { "name": "AWSElasticBeanstalkRoleRDS", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleRDS" }, { "name": "AWSElasticBeanstalkRoleSNS", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleSNS" }, { "name": "AWSElasticBeanstalkRoleWorkerTier", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkRoleWorkerTier" }, { "name": "AWSElasticBeanstalkService", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticBeanstalkService" }, { "name": "AWSElasticBeanstalkServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticBeanstalkServiceRolePolicy" }, { "name": "AWSElasticBeanstalkWebTier", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkWebTier" }, { "name": "AWSElasticBeanstakWorkerTier", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkWorkerTier", "deprecationMessage": "This has been deprecated in favour of `AWSElasticBeanstalkWorkerTier`" }, { "name": "AWSElasticBeanstalkWorkerTier", "value": "arn:aws:iam::aws:policy/AWSElasticBeanstalkWorkerTier" }, { "name": "AWSElasticDisasterRecoveryAgentInstallationPolicy", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryAgentInstallationPolicy" }, { "name": "AWSElasticDisasterRecoveryAgentPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryAgentPolicy" }, { "name": "AWSElasticDisasterRecoveryConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryConsoleFullAccess" }, { "name": "AWSElasticDisasterRecoveryConsoleFullAccess_v2", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryConsoleFullAccess_v2" }, { "name": "AWSElasticDisasterRecoveryConversionServerPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryConversionServerPolicy" }, { "name": "AWSElasticDisasterRecoveryCrossAccountReplicationPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryCrossAccountReplicationPolicy" }, { "name": "AWSElasticDisasterRecoveryEc2InstancePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryEc2InstancePolicy" }, { "name": "AWSElasticDisasterRecoveryFailbackInstallationPolicy", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryFailbackInstallationPolicy" }, { "name": "AWSElasticDisasterRecoveryFailbackPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryFailbackPolicy" }, { "name": "AWSElasticDisasterRecoveryLaunchActionsPolicy", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryLaunchActionsPolicy" }, { "name": "AWSElasticDisasterRecoveryNetworkReplicationPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryNetworkReplicationPolicy" }, { "name": "AWSElasticDisasterRecoveryReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSElasticDisasterRecoveryReadOnlyAccess" }, { "name": "AWSElasticDisasterRecoveryRecoveryInstancePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryRecoveryInstancePolicy" }, { "name": "AWSElasticDisasterRecoveryReplicationServerPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryReplicationServerPolicy" }, { "name": "AWSElasticDisasterRecoveryServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticDisasterRecoveryServiceRolePolicy" }, { "name": "AWSElasticDisasterRecoveryStagingAccountPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryStagingAccountPolicy" }, { "name": "AWSElasticDisasterRecoveryStagingAccountPolicy_v2", "value": "arn:aws:iam::aws:policy/service-role/AWSElasticDisasterRecoveryStagingAccountPolicy_v2" }, { "name": "AWSElasticLoadBalancingClassicServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticLoadBalancingClassicServiceRolePolicy" }, { "name": "AWSElasticLoadBalancingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSElasticLoadBalancingServiceRolePolicy" }, { "name": "AWSElementalMediaConvertFullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaConvertFullAccess" }, { "name": "AWSElementalMediaConvertReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaConvertReadOnly" }, { "name": "AWSElementalMediaLiveFullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaLiveFullAccess" }, { "name": "AWSElementalMediaLiveReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaLiveReadOnly" }, { "name": "AWSElementalMediaPackageFullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaPackageFullAccess" }, { "name": "AWSElementalMediaPackageReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaPackageReadOnly" }, { "name": "AWSElementalMediaPackageV2FullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaPackageV2FullAccess" }, { "name": "AWSElementalMediaPackageV2ReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaPackageV2ReadOnly" }, { "name": "AWSElementalMediaStoreFullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaStoreFullAccess" }, { "name": "AWSElementalMediaStoreReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaStoreReadOnly" }, { "name": "AWSElementalMediaTailorFullAccess", "value": "arn:aws:iam::aws:policy/AWSElementalMediaTailorFullAccess" }, { "name": "AWSElementalMediaTailorReadOnly", "value": "arn:aws:iam::aws:policy/AWSElementalMediaTailorReadOnly" }, { "name": "AWSEnhancedClassicNetworkingMangementPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSEnhancedClassicNetworkingMangementPolicy" }, { "name": "AWSEntityResolutionConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSEntityResolutionConsoleFullAccess" }, { "name": "AWSEntityResolutionConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSEntityResolutionConsoleReadOnlyAccess" }, { "name": "AWSFMAdminFullAccess", "value": "arn:aws:iam::aws:policy/AWSFMAdminFullAccess" }, { "name": "AWSFMAdminReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSFMAdminReadOnlyAccess" }, { "name": "AWSFMMemberReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSFMMemberReadOnlyAccess" }, { "name": "AWSFaultInjectionSimulatorEC2Access", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorEC2Access" }, { "name": "AWSFaultInjectionSimulatorECSAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorECSAccess" }, { "name": "AWSFaultInjectionSimulatorEKSAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorEKSAccess" }, { "name": "AWSFaultInjectionSimulatorNetworkAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorNetworkAccess" }, { "name": "AWSFaultInjectionSimulatorRDSAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorRDSAccess" }, { "name": "AWSFaultInjectionSimulatorSSMAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSFaultInjectionSimulatorSSMAccess" }, { "name": "AWSFinSpaceServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSFinSpaceServiceRolePolicy" }, { "name": "AWSForWordPressPluginPolicy", "value": "arn:aws:iam::aws:policy/AWSForWordPressPluginPolicy" }, { "name": "AWSGitSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSGitSyncServiceRolePolicy" }, { "name": "AWSGlobalAcceleratorSLRPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSGlobalAcceleratorSLRPolicy" }, { "name": "AWSGlueConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess" }, { "name": "AWSGlueConsoleSageMakerNotebookFullAccess", "value": "arn:aws:iam::aws:policy/AWSGlueConsoleSageMakerNotebookFullAccess" }, { "name": "AWSGlueDataBrewServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSGlueDataBrewServiceRole" }, { "name": "AWSGlueSchemaRegistryFullAccess", "value": "arn:aws:iam::aws:policy/AWSGlueSchemaRegistryFullAccess" }, { "name": "AWSGlueSchemaRegistryReadonlyAccess", "value": "arn:aws:iam::aws:policy/AWSGlueSchemaRegistryReadonlyAccess" }, { "name": "AWSGlueServiceNotebookRole", "value": "arn:aws:iam::aws:policy/service-role/AWSGlueServiceNotebookRole" }, { "name": "AWSGlueServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole" }, { "name": "AWSGrafanaAccountAdministrator", "value": "arn:aws:iam::aws:policy/AWSGrafanaAccountAdministrator" }, { "name": "AWSGrafanaConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSGrafanaConsoleReadOnlyAccess" }, { "name": "AWSGrafanaWorkspacePermissionManagement", "value": "arn:aws:iam::aws:policy/AWSGrafanaWorkspacePermissionManagement" }, { "name": "AWSGrafanaWorkspacePermissionManagementV2", "value": "arn:aws:iam::aws:policy/AWSGrafanaWorkspacePermissionManagementV2" }, { "name": "AWSGreengrassFullAccess", "value": "arn:aws:iam::aws:policy/AWSGreengrassFullAccess" }, { "name": "AWSGreengrassFullccess", "value": "arn:aws:iam::aws:policy/AWSGreengrassFullAccess", "deprecationMessage": "Please use AWSGreengrassFullAccess instead" }, { "name": "AWSGreengrassReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSGreengrassReadOnlyAccess" }, { "name": "AWSGreengrassResourceAccessRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy" }, { "name": "AWSGroundStationAgentInstancePolicy", "value": "arn:aws:iam::aws:policy/AWSGroundStationAgentInstancePolicy" }, { "name": "AWSHealthFullAccess", "value": "arn:aws:iam::aws:policy/AWSHealthFullAccess" }, { "name": "AWSHealthImagingFullAccess", "value": "arn:aws:iam::aws:policy/AWSHealthImagingFullAccess" }, { "name": "AWSHealthImagingReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSHealthImagingReadOnlyAccess" }, { "name": "AWSHealth_EventProcessorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSHealth_EventProcessorServiceRolePolicy" }, { "name": "AWSIAMIdentityCenterAllowListForIdentityContext", "value": "arn:aws:iam::aws:policy/AWSIAMIdentityCenterAllowListForIdentityContext" }, { "name": "AWSIPAMServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIPAMServiceRolePolicy" }, { "name": "AWSIQContractServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIQContractServiceRolePolicy" }, { "name": "AWSIQFullAccess", "value": "arn:aws:iam::aws:policy/AWSIQFullAccess" }, { "name": "AWSIQPermissionServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIQPermissionServiceRolePolicy" }, { "name": "AWSIdentitySyncFullAccess", "value": "arn:aws:iam::aws:policy/AWSIdentitySyncFullAccess" }, { "name": "AWSIdentitySyncReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIdentitySyncReadOnlyAccess" }, { "name": "AWSImageBuilderFullAccess", "value": "arn:aws:iam::aws:policy/AWSImageBuilderFullAccess" }, { "name": "AWSImageBuilderReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSImageBuilderReadOnlyAccess" }, { "name": "AWSImportExportFullAccess", "value": "arn:aws:iam::aws:policy/AWSImportExportFullAccess" }, { "name": "AWSImportExportReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSImportExportReadOnlyAccess" }, { "name": "AWSIncidentManagerIncidentAccessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/AWSIncidentManagerIncidentAccessServiceRolePolicy" }, { "name": "AWSIncidentManagerResolverAccess", "value": "arn:aws:iam::aws:policy/AWSIncidentManagerResolverAccess" }, { "name": "AWSIncidentManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIncidentManagerServiceRolePolicy" }, { "name": "AWSIoT1ClickFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoT1ClickFullAccess" }, { "name": "AWSIoT1ClickReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoT1ClickReadOnlyAccess" }, { "name": "AWSIoTAnalyticsFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTAnalyticsFullAccess" }, { "name": "AWSIoTAnalyticsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoTAnalyticsReadOnlyAccess" }, { "name": "AWSIoTConfigAccess", "value": "arn:aws:iam::aws:policy/AWSIoTConfigAccess" }, { "name": "AWSIoTConfigReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoTConfigReadOnlyAccess" }, { "name": "AWSIoTDataAccess", "value": "arn:aws:iam::aws:policy/AWSIoTDataAccess" }, { "name": "AWSIoTDeviceDefenderAddThingsToThingGroupMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderAddThingsToThingGroupMitigationAction" }, { "name": "AWSIoTDeviceDefenderAudit", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderAudit" }, { "name": "AWSIoTDeviceDefenderEnableIoTLoggingMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderEnableIoTLoggingMitigationAction" }, { "name": "AWSIoTDeviceDefenderPublishFindingsToSNSMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderPublishFindingsToSNSMitigationAction" }, { "name": "AWSIoTDeviceDefenderReplaceDefaultPolicyMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderReplaceDefaultPolicyMitigationAction" }, { "name": "AWSIoTDeviceDefenderUpdateCACertMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderUpdateCACertMitigationAction" }, { "name": "AWSIoTDeviceDefenderUpdateDeviceCertMitigationAction", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTDeviceDefenderUpdateDeviceCertMitigationAction" }, { "name": "AWSIoTDeviceTesterForFreeRTOSFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTDeviceTesterForFreeRTOSFullAccess" }, { "name": "AWSIoTDeviceTesterForGreengrassFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTDeviceTesterForGreengrassFullAccess" }, { "name": "AWSIoTEventsFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTEventsFullAccess" }, { "name": "AWSIoTEventsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoTEventsReadOnlyAccess" }, { "name": "AWSIoTFleetHubFederationAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTFleetHubFederationAccess" }, { "name": "AWSIoTFleetwiseServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIoTFleetwiseServiceRolePolicy" }, { "name": "AWSIoTFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTFullAccess" }, { "name": "AWSIoTLogging", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTLogging" }, { "name": "AWSIoTOTAUpdate", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTOTAUpdate" }, { "name": "AWSIoTRuleActions", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTRuleActions" }, { "name": "AWSIoTSiteWiseConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTSiteWiseConsoleFullAccess" }, { "name": "AWSIoTSiteWiseFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTSiteWiseFullAccess" }, { "name": "AWSIoTSiteWiseMonitorPortalAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTSiteWiseMonitorPortalAccess" }, { "name": "AWSIoTSiteWiseMonitorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIoTSiteWiseMonitorServiceRolePolicy" }, { "name": "AWSIoTSiteWiseReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoTSiteWiseReadOnlyAccess" }, { "name": "AWSIoTThingsRegistration", "value": "arn:aws:iam::aws:policy/service-role/AWSIoTThingsRegistration" }, { "name": "AWSIoTTwinMakerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIoTTwinMakerServiceRolePolicy" }, { "name": "AWSIoTWirelessDataAccess", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessDataAccess" }, { "name": "AWSIoTWirelessFullAccess", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessFullAccess" }, { "name": "AWSIoTWirelessFullPublishAccess", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessFullPublishAccess" }, { "name": "AWSIoTWirelessGatewayCertManager", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessGatewayCertManager" }, { "name": "AWSIoTWirelessLogging", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessLogging" }, { "name": "AWSIoTWirelessReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSIoTWirelessReadOnlyAccess" }, { "name": "AWSIotRoboRunnerFullAccess", "value": "arn:aws:iam::aws:policy/AWSIotRoboRunnerFullAccess" }, { "name": "AWSIotRoboRunnerReadOnly", "value": "arn:aws:iam::aws:policy/AWSIotRoboRunnerReadOnly" }, { "name": "AWSIotRoboRunnerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSIotRoboRunnerServiceRolePolicy" }, { "name": "AWSKeyManagementServiceCustomKeyStoresServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSKeyManagementServiceCustomKeyStoresServiceRolePolicy" }, { "name": "AWSKeyManagementServiceMultiRegionKeysServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSKeyManagementServiceMultiRegionKeysServiceRolePolicy" }, { "name": "AWSKeyManagementServicePowerUser", "value": "arn:aws:iam::aws:policy/AWSKeyManagementServicePowerUser" }, { "name": "AWSLakeFormationCrossAccountManager", "value": "arn:aws:iam::aws:policy/AWSLakeFormationCrossAccountManager" }, { "name": "AWSLakeFormationDataAdmin", "value": "arn:aws:iam::aws:policy/AWSLakeFormationDataAdmin" }, { "name": "AWSLambdaBasicExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole" }, { "name": "AWSLambdaDynamoDBExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaDynamoDBExecutionRole" }, { "name": "AWSLambdaENIManagementAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaENIManagementAccess" }, { "name": "AWSLambdaExecute", "value": "arn:aws:iam::aws:policy/AWSLambdaExecute" }, { "name": "AWSLambdaFullAccess", "value": "arn:aws:iam::aws:policy/AWSLambdaFullAccess", "deprecationMessage": "This has been deprecated in favour of `LambdaFullAccess`" }, { "name": "LambdaFullAccess", "value": "arn:aws:iam::aws:policy/AWSLambda_FullAccess" }, { "name": "AWSLambdaInvocationDynamoDB", "value": "arn:aws:iam::aws:policy/AWSLambdaInvocation-DynamoDB" }, { "name": "AWSLambdaKinesisExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaKinesisExecutionRole" }, { "name": "AWSLambdaReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSLambdaReadOnlyAccess", "deprecationMessage": "This has been deprecated in favour of `LambdaReadOnlyAccess`" }, { "name": "LambdaReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSLambda_ReadOnlyAccess" }, { "name": "AWSLambdaMSKExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaMSKExecutionRole" }, { "name": "AWSLambdaReplicator", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLambdaReplicator" }, { "name": "AWSLambdaRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaRole" }, { "name": "AWSLambdaSQSQueueExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaSQSQueueExecutionRole" }, { "name": "AWSLambdaVPCAccessExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole" }, { "name": "AWSLicenseManagerConsumptionPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSLicenseManagerConsumptionPolicy" }, { "name": "AWSLicenseManagerLinuxSubscriptionsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLicenseManagerLinuxSubscriptionsServiceRolePolicy" }, { "name": "AWSLicenseManagerMasterAccountRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLicenseManagerMasterAccountRolePolicy" }, { "name": "AWSLicenseManagerMemberAccountRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLicenseManagerMemberAccountRolePolicy" }, { "name": "AWSLicenseManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLicenseManagerServiceRolePolicy" }, { "name": "AWSLicenseManagerUserSubscriptionsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSLicenseManagerUserSubscriptionsServiceRolePolicy" }, { "name": "AWSM2ServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSM2ServicePolicy" }, { "name": "AWSMSKReplicatorExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AWSMSKReplicatorExecutionRole" }, { "name": "AWSManagedServicesDeploymentToolkitPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSManagedServicesDeploymentToolkitPolicy" }, { "name": "AWSManagedServices_ContactsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSManagedServices_ContactsServiceRolePolicy" }, { "name": "AWSManagedServices_DetectiveControlsConfig_ServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSManagedServices_DetectiveControlsConfig_ServiceRolePolicy" }, { "name": "AWSManagedServices_EventsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSManagedServices_EventsServiceRolePolicy" }, { "name": "AWSMarketplaceAmiIngestion", "value": "arn:aws:iam::aws:policy/AWSMarketplaceAmiIngestion" }, { "name": "AWSMarketplaceDeploymentServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMarketplaceDeploymentServiceRolePolicy" }, { "name": "AWSMarketplaceFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceFullAccess" }, { "name": "AWSMarketplaceGetEntitlements", "value": "arn:aws:iam::aws:policy/AWSMarketplaceGetEntitlements" }, { "name": "AWSMarketplaceImageBuildFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceImageBuildFullAccess" }, { "name": "AWSMarketplaceLicenseManagementServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMarketplaceLicenseManagementServiceRolePolicy" }, { "name": "AWSMarketplaceManageSubscriptions", "value": "arn:aws:iam::aws:policy/AWSMarketplaceManageSubscriptions" }, { "name": "AWSMarketplaceMeteringFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess" }, { "name": "AWSMarketplaceMeteringRegisterUsage", "value": "arn:aws:iam::aws:policy/AWSMarketplaceMeteringRegisterUsage" }, { "name": "AWSMarketplaceProcurementSystemAdminFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceProcurementSystemAdminFullAccess" }, { "name": "AWSMarketplacePurchaseOrdersServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMarketplacePurchaseOrdersServiceRolePolicy" }, { "name": "AWSMarketplaceReadonly", "value": "arn:aws:iam::aws:policy/AWSMarketplaceRead-only" }, { "name": "AWSMarketplaceResaleAuthorizationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMarketplaceResaleAuthorizationServiceRolePolicy" }, { "name": "AWSMarketplaceSellerFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceSellerFullAccess" }, { "name": "AWSMarketplaceSellerProductsFullAccess", "value": "arn:aws:iam::aws:policy/AWSMarketplaceSellerProductsFullAccess" }, { "name": "AWSMarketplaceSellerProductsReadOnly", "value": "arn:aws:iam::aws:policy/AWSMarketplaceSellerProductsReadOnly" }, { "name": "AWSMediaConnectServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMediaConnectServicePolicy" }, { "name": "AWSMediaTailorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMediaTailorServiceRolePolicy" }, { "name": "AWSMigrationHubDMSAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSMigrationHubDMSAccess" }, { "name": "AWSMigrationHubDiscoveryAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSMigrationHubDiscoveryAccess" }, { "name": "AWSMigrationHubFullAccess", "value": "arn:aws:iam::aws:policy/AWSMigrationHubFullAccess" }, { "name": "AWSMigrationHubOrchestratorConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSMigrationHubOrchestratorConsoleFullAccess" }, { "name": "AWSMigrationHubOrchestratorInstanceRolePolicy", "value": "arn:aws:iam::aws:policy/AWSMigrationHubOrchestratorInstanceRolePolicy" }, { "name": "AWSMigrationHubOrchestratorPlugin", "value": "arn:aws:iam::aws:policy/AWSMigrationHubOrchestratorPlugin" }, { "name": "AWSMigrationHubOrchestratorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMigrationHubOrchestratorServiceRolePolicy" }, { "name": "AWSMigrationHubRefactorSpacesEnvironmentsWithoutBridgesFullAccess", "value": "arn:aws:iam::aws:policy/AWSMigrationHubRefactorSpaces-EnvironmentsWithoutBridgesFullAccess" }, { "name": "AWSMigrationHubRefactorSpacesSSMAutomationPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSMigrationHubRefactorSpaces-SSMAutomationPolicy" }, { "name": "AWSMigrationHubRefactorSpacesFullAccess", "value": "arn:aws:iam::aws:policy/AWSMigrationHubRefactorSpacesFullAccess" }, { "name": "AWSMigrationHubRefactorSpacesServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMigrationHubRefactorSpacesServiceRolePolicy" }, { "name": "AWSMigrationHubSMSAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSMigrationHubSMSAccess" }, { "name": "AWSMigrationHubStrategyCollector", "value": "arn:aws:iam::aws:policy/AWSMigrationHubStrategyCollector" }, { "name": "AWSMigrationHubStrategyConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSMigrationHubStrategyConsoleFullAccess" }, { "name": "AWSMigrationHubStrategyServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSMigrationHubStrategyServiceRolePolicy" }, { "name": "AWSMobileHub_FullAccess", "value": "arn:aws:iam::aws:policy/AWSMobileHub_FullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AWSMobileHub_ReadOnly", "value": "arn:aws:iam::aws:policy/AWSMobileHub_ReadOnly", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AWSMobileHub_ServiceUseOnly", "value": "arn:aws:iam::aws:policy/service-role/AWSMobileHub_ServiceUseOnly", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AWSNetworkFirewallServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSNetworkFirewallServiceRolePolicy" }, { "name": "AWSNetworkManagerCloudWANServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSNetworkManagerCloudWANServiceRolePolicy" }, { "name": "AWSNetworkManagerFullAccess", "value": "arn:aws:iam::aws:policy/AWSNetworkManagerFullAccess" }, { "name": "AWSNetworkManagerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSNetworkManagerReadOnlyAccess" }, { "name": "AWSNetworkManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSNetworkManagerServiceRolePolicy" }, { "name": "AWSOpsWorksCMInstanceProfileRole", "value": "arn:aws:iam::aws:policy/AWSOpsWorksCMInstanceProfileRole" }, { "name": "AWSOpsWorksCMServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AWSOpsWorksCMServiceRole" }, { "name": "AWSOpsWorksCloudWatchLogs", "value": "arn:aws:iam::aws:policy/AWSOpsWorksCloudWatchLogs" }, { "name": "AWSOpsWorksFullAccess", "value": "arn:aws:iam::aws:policy/AWSOpsWorksFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Please use OpsWorks_FullAccess instead." }, { "name": "AWSOpsWorksInstanceRegistration", "value": "arn:aws:iam::aws:policy/AWSOpsWorksInstanceRegistration" }, { "name": "AWSOpsWorksRegisterCLI", "value": "arn:aws:iam::aws:policy/AWSOpsWorksRegisterCLI", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Please use AWSOpsWorksRegisterCLI_EC2 or AWSOpsWorksRegisterCLI_OnPremises instead." }, { "name": "AWSOpsWorksRole", "value": "arn:aws:iam::aws:policy/service-role/AWSOpsWorksRole", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Please use AWSOpsWorksCMServiceRole instead." }, { "name": "AWSQuickSightDescribeRD", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightDescribeRDS", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Please use AWSQuickSightDescribeRDS instead." }, { "name": "AWSOpsWorksRegisterCLI_EC2", "value": "arn:aws:iam::aws:policy/AWSOpsWorksRegisterCLI_EC2" }, { "name": "AWSOpsWorksRegisterCLI_OnPremises", "value": "arn:aws:iam::aws:policy/AWSOpsWorksRegisterCLI_OnPremises" }, { "name": "OpsWorks_FullAccess", "value": "arn:aws:iam::aws:policy/AWSOpsWorks_FullAccess" }, { "name": "AWSOrganizationsFullAccess", "value": "arn:aws:iam::aws:policy/AWSOrganizationsFullAccess" }, { "name": "AWSOrganizationsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSOrganizationsReadOnlyAccess" }, { "name": "AWSOrganizationsServiceTrustPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSOrganizationsServiceTrustPolicy" }, { "name": "AWSOutpostsAuthorizeServerPolicy", "value": "arn:aws:iam::aws:policy/AWSOutpostsAuthorizeServerPolicy" }, { "name": "AWSOutpostsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSOutpostsServiceRolePolicy" }, { "name": "AWSPanoramaApplianceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSPanoramaApplianceRolePolicy" }, { "name": "AWSPanoramaApplianceServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSPanoramaApplianceServiceRolePolicy" }, { "name": "AWSPanoramaFullAccess", "value": "arn:aws:iam::aws:policy/AWSPanoramaFullAccess" }, { "name": "AWSPanoramaGreengrassGroupRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSPanoramaGreengrassGroupRolePolicy" }, { "name": "AWSPanoramaSageMakerRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSPanoramaSageMakerRolePolicy" }, { "name": "AWSPanoramaServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSPanoramaServiceLinkedRolePolicy" }, { "name": "AWSPanoramaServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSPanoramaServiceRolePolicy" }, { "name": "AWSPriceListServiceFullAccess", "value": "arn:aws:iam::aws:policy/AWSPriceListServiceFullAccess" }, { "name": "AWSPrivateCAAuditor", "value": "arn:aws:iam::aws:policy/AWSPrivateCAAuditor" }, { "name": "AWSPrivateCAFullAccess", "value": "arn:aws:iam::aws:policy/AWSPrivateCAFullAccess" }, { "name": "AWSPrivateCAPrivilegedUser", "value": "arn:aws:iam::aws:policy/AWSPrivateCAPrivilegedUser" }, { "name": "AWSPrivateCAReadOnly", "value": "arn:aws:iam::aws:policy/AWSPrivateCAReadOnly" }, { "name": "AWSPrivateCAUser", "value": "arn:aws:iam::aws:policy/AWSPrivateCAUser" }, { "name": "AWSPrivateMarketplaceAdminFullAccess", "value": "arn:aws:iam::aws:policy/AWSPrivateMarketplaceAdminFullAccess" }, { "name": "AWSPrivateMarketplaceRequests", "value": "arn:aws:iam::aws:policy/AWSPrivateMarketplaceRequests" }, { "name": "AWSPrivateNetworksServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSPrivateNetworksServiceRolePolicy" }, { "name": "AWSProtonCodeBuildProvisioningBasicAccess", "value": "arn:aws:iam::aws:policy/AWSProtonCodeBuildProvisioningBasicAccess" }, { "name": "AWSProtonCodeBuildProvisioningServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSProtonCodeBuildProvisioningServiceRolePolicy" }, { "name": "AWSProtonDeveloperAccess", "value": "arn:aws:iam::aws:policy/AWSProtonDeveloperAccess" }, { "name": "AWSProtonFullAccess", "value": "arn:aws:iam::aws:policy/AWSProtonFullAccess" }, { "name": "AWSProtonReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSProtonReadOnlyAccess" }, { "name": "AWSProtonServiceGitSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSProtonServiceGitSyncServiceRolePolicy" }, { "name": "AWSProtonSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSProtonSyncServiceRolePolicy" }, { "name": "AWSPurchaseOrdersServiceRolePolicy", "value": "arn:aws:iam::aws:policy/AWSPurchaseOrdersServiceRolePolicy" }, { "name": "AWSQuickSightDescribeRDS", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightDescribeRDS" }, { "name": "AWSQuickSightDescribeRedshift", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightDescribeRedshift" }, { "name": "AWSQuickSightElasticsearchPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightElasticsearchPolicy" }, { "name": "AWSQuickSightIoTAnalyticsAccess", "value": "arn:aws:iam::aws:policy/AWSQuickSightIoTAnalyticsAccess" }, { "name": "AWSQuickSightListIAM", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightListIAM" }, { "name": "AWSQuickSightSageMakerPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightSageMakerPolicy" }, { "name": "AWSQuickSightTimestreamPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSQuickSightTimestreamPolicy" }, { "name": "AWSQuicksightAthenaAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSQuicksightAthenaAccess" }, { "name": "AWSQuicksightOpenSearchPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSQuicksightOpenSearchPolicy" }, { "name": "AWSReachabilityAnalyzerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSReachabilityAnalyzerServiceRolePolicy" }, { "name": "AWSRefactoringToolkitFullAccess", "value": "arn:aws:iam::aws:policy/AWSRefactoringToolkitFullAccess" }, { "name": "AWSRefactoringToolkitSidecarPolicy", "value": "arn:aws:iam::aws:policy/AWSRefactoringToolkitSidecarPolicy" }, { "name": "AWSRepostSpaceSupportOperationsPolicy", "value": "arn:aws:iam::aws:policy/AWSRepostSpaceSupportOperationsPolicy" }, { "name": "AWSResilienceHubAsssessmentExecutionPolicy", "value": "arn:aws:iam::aws:policy/AWSResilienceHubAsssessmentExecutionPolicy" }, { "name": "AWSResourceAccessManagerFullAccess", "value": "arn:aws:iam::aws:policy/AWSResourceAccessManagerFullAccess" }, { "name": "AWSResourceAccessManagerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSResourceAccessManagerReadOnlyAccess" }, { "name": "AWSResourceAccessManagerResourceShareParticipantAccess", "value": "arn:aws:iam::aws:policy/AWSResourceAccessManagerResourceShareParticipantAccess" }, { "name": "AWSResourceAccessManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSResourceAccessManagerServiceRolePolicy" }, { "name": "AWSResourceExplorerFullAccess", "value": "arn:aws:iam::aws:policy/AWSResourceExplorerFullAccess" }, { "name": "AWSResourceExplorerOrganizationsAccess", "value": "arn:aws:iam::aws:policy/AWSResourceExplorerOrganizationsAccess" }, { "name": "AWSResourceExplorerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSResourceExplorerReadOnlyAccess" }, { "name": "AWSResourceExplorerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSResourceExplorerServiceRolePolicy" }, { "name": "AWSResourceGroupsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSResourceGroupsReadOnlyAccess" }, { "name": "AWSRoboMakerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSRoboMakerReadOnlyAccess" }, { "name": "AWSRoboMakerServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSRoboMakerServicePolicy" }, { "name": "AWSRoboMakerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/AWSRoboMakerServiceRolePolicy" }, { "name": "AWSRoboMaker_FullAccess", "value": "arn:aws:iam::aws:policy/AWSRoboMaker_FullAccess" }, { "name": "AWSRolesAnywhereServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSRolesAnywhereServicePolicy" }, { "name": "AWSS3OnOutpostsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSS3OnOutpostsServiceRolePolicy" }, { "name": "AWSSSMForSAPServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSSMForSAPServiceLinkedRolePolicy" }, { "name": "AWSSSMOpsInsightsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSSMOpsInsightsServiceRolePolicy" }, { "name": "AWSSSODirectoryAdministrator", "value": "arn:aws:iam::aws:policy/AWSSSODirectoryAdministrator" }, { "name": "AWSSSODirectoryReadOnly", "value": "arn:aws:iam::aws:policy/AWSSSODirectoryReadOnly" }, { "name": "AWSSSOMasterAccountAdministrator", "value": "arn:aws:iam::aws:policy/AWSSSOMasterAccountAdministrator" }, { "name": "AWSSSOMemberAccountAdministrator", "value": "arn:aws:iam::aws:policy/AWSSSOMemberAccountAdministrator" }, { "name": "AWSSSOReadOnly", "value": "arn:aws:iam::aws:policy/AWSSSOReadOnly" }, { "name": "AWSSSOServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSSOServiceRolePolicy" }, { "name": "AWSSavingsPlansFullAccess", "value": "arn:aws:iam::aws:policy/AWSSavingsPlansFullAccess" }, { "name": "AWSSavingsPlansReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSSavingsPlansReadOnlyAccess" }, { "name": "AWSSecurityHubFullAccess", "value": "arn:aws:iam::aws:policy/AWSSecurityHubFullAccess" }, { "name": "AWSSecurityHubOrganizationsAccess", "value": "arn:aws:iam::aws:policy/AWSSecurityHubOrganizationsAccess" }, { "name": "AWSSecurityHubReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSSecurityHubReadOnlyAccess" }, { "name": "AWSSecurityHubServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSecurityHubServiceRolePolicy" }, { "name": "AWSServiceCatalogAdminFullAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogAdminFullAccess" }, { "name": "AWSServiceCatalogAdminReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogAdminReadOnlyAccess" }, { "name": "AWSServiceCatalogAppRegistryFullAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogAppRegistryFullAccess" }, { "name": "AWSServiceCatalogAppRegistryReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogAppRegistryReadOnlyAccess" }, { "name": "AWSServiceCatalogAppRegistryServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceCatalogAppRegistryServiceRolePolicy" }, { "name": "AWSServiceCatalogEndUserFullAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogEndUserFullAccess" }, { "name": "AWSServiceCatalogEndUserReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSServiceCatalogEndUserReadOnlyAccess" }, { "name": "AWSServiceCatalogOrgsDataSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceCatalogOrgsDataSyncServiceRolePolicy" }, { "name": "AWSServiceCatalogSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceCatalogSyncServiceRolePolicy" }, { "name": "AWSServiceRoleForAmazonEKSNodegroup", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForAmazonEKSNodegroup" }, { "name": "AWSServiceRoleForCloudWatchAlarmsActionSSMServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForCloudWatchAlarmsActionSSMServiceRolePolicy" }, { "name": "AWSServiceRoleForCloudWatchMetrics_DbPerfInsightsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForCloudWatchMetrics_DbPerfInsightsServiceRolePolicy" }, { "name": "AWSServiceRoleForCodeGuruProfiler", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForCodeGuru-Profiler" }, { "name": "AWSServiceRoleForCodeWhispererPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForCodeWhispererPolicy" }, { "name": "AWSServiceRoleForEC2ScheduledInstances", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForEC2ScheduledInstances" }, { "name": "AWSServiceRoleForGroundStationDataflowEndpointGroupPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForGroundStationDataflowEndpointGroupPolicy" }, { "name": "AWSServiceRoleForImageBuilder", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForImageBuilder" }, { "name": "AWSServiceRoleForIoTSiteWise", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForIoTSiteWise" }, { "name": "AWSServiceRoleForLogDeliveryPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForLogDeliveryPolicy" }, { "name": "AWSServiceRoleForMonitronPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForMonitronPolicy" }, { "name": "AWSServiceRoleForNeptuneGraphPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForNeptuneGraphPolicy" }, { "name": "AWSServiceRoleForPrivateMarketplaceAdminPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForPrivateMarketplaceAdminPolicy" }, { "name": "AWSServiceRoleForSMS", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRoleForSMS" }, { "name": "AWSServiceRolePolicyForBackupReports", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRolePolicyForBackupReports" }, { "name": "AWSServiceRolePolicyForBackupRestoreTesting", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSServiceRolePolicyForBackupRestoreTesting" }, { "name": "AWSShieldDRTAccessPolicy", "value": "arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy" }, { "name": "AWSShieldServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSShieldServiceRolePolicy" }, { "name": "AWSStepFunctionsConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSStepFunctionsConsoleFullAccess" }, { "name": "AWSStepFunctionsFullAccess", "value": "arn:aws:iam::aws:policy/AWSStepFunctionsFullAccess" }, { "name": "AWSStepFunctionsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSStepFunctionsReadOnlyAccess" }, { "name": "AWSStorageGatewayFullAccess", "value": "arn:aws:iam::aws:policy/AWSStorageGatewayFullAccess" }, { "name": "AWSStorageGatewayReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSStorageGatewayReadOnlyAccess" }, { "name": "AWSStorageGatewayServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSStorageGatewayServiceRolePolicy" }, { "name": "AWSSupplyChainFederationAdminAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSSupplyChainFederationAdminAccess" }, { "name": "AWSSupportAccess", "value": "arn:aws:iam::aws:policy/AWSSupportAccess" }, { "name": "AWSSupportAppFullAccess", "value": "arn:aws:iam::aws:policy/AWSSupportAppFullAccess" }, { "name": "AWSSupportAppReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSSupportAppReadOnlyAccess" }, { "name": "AWSSupportPlansFullAccess", "value": "arn:aws:iam::aws:policy/AWSSupportPlansFullAccess" }, { "name": "AWSSupportPlansReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSSupportPlansReadOnlyAccess" }, { "name": "AWSSupportServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSupportServiceRolePolicy" }, { "name": "AWSSystemsManagerAccountDiscoveryServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSystemsManagerAccountDiscoveryServicePolicy" }, { "name": "AWSSystemsManagerChangeManagementServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSystemsManagerChangeManagementServicePolicy" }, { "name": "AWSSystemsManagerForSAPFullAccess", "value": "arn:aws:iam::aws:policy/AWSSystemsManagerForSAPFullAccess" }, { "name": "AWSSystemsManagerForSAPReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSSystemsManagerForSAPReadOnlyAccess" }, { "name": "AWSSystemsManagerOpsDataSyncServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSSystemsManagerOpsDataSyncServiceRolePolicy" }, { "name": "AWSThinkboxAWSPortalAdminPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxAWSPortalAdminPolicy" }, { "name": "AWSThinkboxAWSPortalGatewayPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxAWSPortalGatewayPolicy" }, { "name": "AWSThinkboxAWSPortalWorkerPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxAWSPortalWorkerPolicy" }, { "name": "AWSThinkboxAssetServerPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxAssetServerPolicy" }, { "name": "AWSThinkboxDeadlineResourceTrackerAccessPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxDeadlineResourceTrackerAccessPolicy" }, { "name": "AWSThinkboxDeadlineResourceTrackerAdminPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxDeadlineResourceTrackerAdminPolicy" }, { "name": "AWSThinkboxDeadlineSpotEventPluginAdminPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxDeadlineSpotEventPluginAdminPolicy" }, { "name": "AWSThinkboxDeadlineSpotEventPluginWorkerPolicy", "value": "arn:aws:iam::aws:policy/AWSThinkboxDeadlineSpotEventPluginWorkerPolicy" }, { "name": "AWSTransferConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSTransferConsoleFullAccess" }, { "name": "AWSTransferFullAccess", "value": "arn:aws:iam::aws:policy/AWSTransferFullAccess" }, { "name": "AWSTransferLoggingAccess", "value": "arn:aws:iam::aws:policy/service-role/AWSTransferLoggingAccess" }, { "name": "AWSTransferReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSTransferReadOnlyAccess" }, { "name": "AWSTrustedAdvisorPriorityFullAccess", "value": "arn:aws:iam::aws:policy/AWSTrustedAdvisorPriorityFullAccess" }, { "name": "AWSTrustedAdvisorPriorityReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSTrustedAdvisorPriorityReadOnlyAccess" }, { "name": "AWSTrustedAdvisorReportingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSTrustedAdvisorReportingServiceRolePolicy" }, { "name": "AWSTrustedAdvisorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSTrustedAdvisorServiceRolePolicy" }, { "name": "AWSUserNotificationsServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSUserNotificationsServiceLinkedRolePolicy" }, { "name": "AWSVPCS2SVpnServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSVPCS2SVpnServiceRolePolicy" }, { "name": "AWSVPCTransitGatewayServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSVPCTransitGatewayServiceRolePolicy" }, { "name": "AWSVPCVerifiedAccessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSVPCVerifiedAccessServiceRolePolicy" }, { "name": "AWSVendorInsightsAssessorFullAccess", "value": "arn:aws:iam::aws:policy/AWSVendorInsightsAssessorFullAccess" }, { "name": "AWSVendorInsightsAssessorReadOnly", "value": "arn:aws:iam::aws:policy/AWSVendorInsightsAssessorReadOnly" }, { "name": "AWSVendorInsightsVendorFullAccess", "value": "arn:aws:iam::aws:policy/AWSVendorInsightsVendorFullAccess" }, { "name": "AWSVendorInsightsVendorReadOnly", "value": "arn:aws:iam::aws:policy/AWSVendorInsightsVendorReadOnly" }, { "name": "AWSVpcLatticeServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSVpcLatticeServiceRolePolicy" }, { "name": "AWSWAFConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AWSWAFConsoleFullAccess" }, { "name": "AWSWAFConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSWAFConsoleReadOnlyAccess" }, { "name": "AWSWAFFullAccess", "value": "arn:aws:iam::aws:policy/AWSWAFFullAccess" }, { "name": "AWSWAFReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSWAFReadOnlyAccess" }, { "name": "AWSWellArchitectedDiscoveryServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSWellArchitectedDiscoveryServiceRolePolicy" }, { "name": "AWSWellArchitectedOrganizationsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSWellArchitectedOrganizationsServiceRolePolicy" }, { "name": "AWSWickrFullAccess", "value": "arn:aws:iam::aws:policy/AWSWickrFullAccess" }, { "name": "AWSXRayDaemonWriteAccess", "value": "arn:aws:iam::aws:policy/AWSXRayDaemonWriteAccess" }, { "name": "AWSXrayCrossAccountSharingConfiguration", "value": "arn:aws:iam::aws:policy/AWSXrayCrossAccountSharingConfiguration" }, { "name": "AWSXrayFullAccess", "value": "arn:aws:iam::aws:policy/AWSXrayFullAccess" }, { "name": "AWSXrayReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSXrayReadOnlyAccess" }, { "name": "AWSXrayWriteOnlyAccess", "value": "arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess" }, { "name": "AWSZonalAutoshiftPracticeRunSLRPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSZonalAutoshiftPracticeRunSLRPolicy" }, { "name": "AWSrePostPrivateCloudWatchAccess", "value": "arn:aws:iam::aws:policy/aws-service-role/AWSrePostPrivateCloudWatchAccess" }, { "name": "AccessAnalyzerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AccessAnalyzerServiceRolePolicy" }, { "name": "AdministratorAccess", "value": "arn:aws:iam::aws:policy/AdministratorAccess" }, { "name": "AdministratorAccessAWSElasticBeanstalk", "value": "arn:aws:iam::aws:policy/AdministratorAccess-AWSElasticBeanstalk" }, { "name": "AdministratorAccessAmplify", "value": "arn:aws:iam::aws:policy/AdministratorAccess-Amplify" }, { "name": "AlexaForBusinessDeviceSetup", "value": "arn:aws:iam::aws:policy/AlexaForBusinessDeviceSetup" }, { "name": "AlexaForBusinessFullAccess", "value": "arn:aws:iam::aws:policy/AlexaForBusinessFullAccess" }, { "name": "AlexaForBusinessGatewayExecution", "value": "arn:aws:iam::aws:policy/AlexaForBusinessGatewayExecution" }, { "name": "AlexaForBusinessLifesizeDelegatedAccessPolicy", "value": "arn:aws:iam::aws:policy/AlexaForBusinessLifesizeDelegatedAccessPolicy" }, { "name": "AlexaForBusinessNetworkProfileServicePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AlexaForBusinessNetworkProfileServicePolicy" }, { "name": "AlexaForBusinessPolyDelegatedAccessPolicy", "value": "arn:aws:iam::aws:policy/AlexaForBusinessPolyDelegatedAccessPolicy" }, { "name": "AlexaForBusinessReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AlexaForBusinessReadOnlyAccess" }, { "name": "AmazonAPIGatewayAdministrator", "value": "arn:aws:iam::aws:policy/AmazonAPIGatewayAdministrator" }, { "name": "AmazonAPIGatewayInvokeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAPIGatewayInvokeFullAccess" }, { "name": "AmazonAPIGatewayPushToCloudWatchLogs", "value": "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs" }, { "name": "AmazonAppFlowFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAppFlowFullAccess" }, { "name": "AmazonAppFlowReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonAppFlowReadOnlyAccess" }, { "name": "AmazonAppStreamFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAppStreamFullAccess" }, { "name": "AmazonAppStreamPCAAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonAppStreamPCAAccess" }, { "name": "AmazonAppStreamReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonAppStreamReadOnlyAccess" }, { "name": "AmazonAppStreamServiceAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonAppStreamServiceAccess" }, { "name": "AmazonAthenaFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAthenaFullAccess" }, { "name": "AmazonAugmentedAIFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAugmentedAIFullAccess" }, { "name": "AmazonAugmentedAIHumanLoopFullAccess", "value": "arn:aws:iam::aws:policy/AmazonAugmentedAIHumanLoopFullAccess" }, { "name": "AmazonAugmentedAIIntegratedAPIAccess", "value": "arn:aws:iam::aws:policy/AmazonAugmentedAIIntegratedAPIAccess" }, { "name": "AmazonBedrockFullAccess", "value": "arn:aws:iam::aws:policy/AmazonBedrockFullAccess" }, { "name": "AmazonBedrockReadOnly", "value": "arn:aws:iam::aws:policy/AmazonBedrockReadOnly" }, { "name": "AmazonBraketFullAccess", "value": "arn:aws:iam::aws:policy/AmazonBraketFullAccess" }, { "name": "AmazonBraketJobsExecutionPolicy", "value": "arn:aws:iam::aws:policy/AmazonBraketJobsExecutionPolicy" }, { "name": "AmazonBraketServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonBraketServiceRolePolicy" }, { "name": "AmazonChimeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonChimeFullAccess" }, { "name": "AmazonChimeReadOnly", "value": "arn:aws:iam::aws:policy/AmazonChimeReadOnly" }, { "name": "AmazonChimeSDK", "value": "arn:aws:iam::aws:policy/AmazonChimeSDK" }, { "name": "AmazonChimeSDKMediaPipelinesServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonChimeSDKMediaPipelinesServiceLinkedRolePolicy" }, { "name": "AmazonChimeSDKMessagingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonChimeSDKMessagingServiceRolePolicy" }, { "name": "AmazonChimeServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonChimeServiceRolePolicy" }, { "name": "AmazonChimeTranscriptionServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonChimeTranscriptionServiceLinkedRolePolicy" }, { "name": "AmazonChimeUserManagement", "value": "arn:aws:iam::aws:policy/AmazonChimeUserManagement" }, { "name": "AmazonChimeVoiceConnectorServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonChimeVoiceConnectorServiceLinkedRolePolicy" }, { "name": "AmazonCloudDirectoryFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudDirectoryFullAccess" }, { "name": "AmazonCloudDirectoryReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudDirectoryReadOnlyAccess" }, { "name": "AmazonCloudWatchEvidentlyFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudWatchEvidentlyFullAccess" }, { "name": "AmazonCloudWatchEvidentlyReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudWatchEvidentlyReadOnlyAccess" }, { "name": "AmazonCloudWatchEvidentlyServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonCloudWatchEvidentlyServiceRolePolicy" }, { "name": "AmazonCloudWatchRUMFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudWatchRUMFullAccess" }, { "name": "AmazonCloudWatchRUMReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCloudWatchRUMReadOnlyAccess" }, { "name": "AmazonCloudWatchRUMServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonCloudWatchRUMServiceRolePolicy" }, { "name": "AmazonCodeCatalystFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeCatalystFullAccess" }, { "name": "AmazonCodeCatalystReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeCatalystReadOnlyAccess" }, { "name": "AmazonCodeCatalystSupportAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonCodeCatalystSupportAccess" }, { "name": "AmazonCodeGuruProfilerAgentAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruProfilerAgentAccess" }, { "name": "AmazonCodeGuruProfilerFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruProfilerFullAccess" }, { "name": "AmazonCodeGuruProfilerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruProfilerReadOnlyAccess" }, { "name": "AmazonCodeGuruReviewerFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruReviewerFullAccess" }, { "name": "AmazonCodeGuruReviewerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruReviewerReadOnlyAccess" }, { "name": "AmazonCodeGuruReviewerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonCodeGuruReviewerServiceRolePolicy" }, { "name": "AmazonCodeGuruSecurityFullAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruSecurityFullAccess" }, { "name": "AmazonCodeGuruSecurityScanAccess", "value": "arn:aws:iam::aws:policy/AmazonCodeGuruSecurityScanAccess" }, { "name": "AmazonCognitoDeveloperAuthenticatedIdentities", "value": "arn:aws:iam::aws:policy/AmazonCognitoDeveloperAuthenticatedIdentities" }, { "name": "AmazonCognitoIdpEmailServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonCognitoIdpEmailServiceRolePolicy" }, { "name": "AmazonCognitoIdpServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonCognitoIdpServiceRolePolicy" }, { "name": "AmazonCognitoPowerUser", "value": "arn:aws:iam::aws:policy/AmazonCognitoPowerUser" }, { "name": "AmazonCognitoReadOnly", "value": "arn:aws:iam::aws:policy/AmazonCognitoReadOnly" }, { "name": "AmazonCognitoUnAuthedIdentitiesSessionPolicy", "value": "arn:aws:iam::aws:policy/AmazonCognitoUnAuthedIdentitiesSessionPolicy" }, { "name": "AmazonCognitoUnauthenticatedIdentities", "value": "arn:aws:iam::aws:policy/AmazonCognitoUnauthenticatedIdentities" }, { "name": "AmazonConnectCampaignsServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonConnectCampaignsServiceLinkedRolePolicy" }, { "name": "AmazonConnectReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonConnectReadOnlyAccess" }, { "name": "AmazonConnectServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonConnectServiceLinkedRolePolicy" }, { "name": "AmazonConnectSynchronizationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonConnectSynchronizationServiceRolePolicy" }, { "name": "AmazonConnectVoiceIDFullAccess", "value": "arn:aws:iam::aws:policy/AmazonConnectVoiceIDFullAccess" }, { "name": "AmazonConnect_FullAccess", "value": "arn:aws:iam::aws:policy/AmazonConnect_FullAccess" }, { "name": "AmazonDMSCloudWatchLogsRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole" }, { "name": "AmazonDMSRedshiftS3Role", "value": "arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role" }, { "name": "AmazonDMSVPCManagementRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole" }, { "name": "AmazonDRSVPCManagement", "value": "arn:aws:iam::aws:policy/AmazonDRSVPCManagement" }, { "name": "AmazonDataZoneDomainExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonDataZoneDomainExecutionRolePolicy" }, { "name": "AmazonDataZoneEnvironmentRolePermissionsBoundary", "value": "arn:aws:iam::aws:policy/AmazonDataZoneEnvironmentRolePermissionsBoundary" }, { "name": "AmazonDataZoneFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDataZoneFullAccess" }, { "name": "AmazonDataZoneFullUserAccess", "value": "arn:aws:iam::aws:policy/AmazonDataZoneFullUserAccess" }, { "name": "AmazonDataZoneGlueManageAccessRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonDataZoneGlueManageAccessRolePolicy" }, { "name": "AmazonDataZoneRedshiftGlueProvisioningPolicy", "value": "arn:aws:iam::aws:policy/AmazonDataZoneRedshiftGlueProvisioningPolicy" }, { "name": "AmazonDataZoneRedshiftManageAccessRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonDataZoneRedshiftManageAccessRolePolicy" }, { "name": "AmazonDetectiveFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDetectiveFullAccess" }, { "name": "AmazonDetectiveInvestigatorAccess", "value": "arn:aws:iam::aws:policy/AmazonDetectiveInvestigatorAccess" }, { "name": "AmazonDetectiveMemberAccess", "value": "arn:aws:iam::aws:policy/AmazonDetectiveMemberAccess" }, { "name": "AmazonDetectiveOrganizationsAccess", "value": "arn:aws:iam::aws:policy/AmazonDetectiveOrganizationsAccess" }, { "name": "AmazonDetectiveServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonDetectiveServiceLinkedRolePolicy" }, { "name": "AmazonDevOpsGuruConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDevOpsGuruConsoleFullAccess" }, { "name": "AmazonDevOpsGuruFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDevOpsGuruFullAccess" }, { "name": "AmazonDevOpsGuruOrganizationsAccess", "value": "arn:aws:iam::aws:policy/AmazonDevOpsGuruOrganizationsAccess" }, { "name": "AmazonDevOpsGuruReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonDevOpsGuruReadOnlyAccess" }, { "name": "AmazonDevOpsGuruServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonDevOpsGuruServiceRolePolicy" }, { "name": "AmazonDocDBElasticServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonDocDB-ElasticServiceRolePolicy" }, { "name": "AmazonDocDBConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDocDBConsoleFullAccess" }, { "name": "AmazonDocDBElasticFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDocDBElasticFullAccess" }, { "name": "AmazonDocDBElasticReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonDocDBElasticReadOnlyAccess" }, { "name": "AmazonDocDBFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDocDBFullAccess" }, { "name": "AmazonDocDBReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonDocDBReadOnlyAccess" }, { "name": "AmazonDynamoDBFullAccess", "value": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" }, { "name": "AmazonDynamoDBFullAccesswithDataPipeline", "value": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccesswithDataPipeline" }, { "name": "AmazonDynamoDBReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonDynamoDBReadOnlyAccess" }, { "name": "AmazonEBSCSIDriverPolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonEBSCSIDriverPolicy" }, { "name": "AmazonEC2ContainerRegistryFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryFullAccess" }, { "name": "AmazonEC2ContainerRegistryPowerUser", "value": "arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryPowerUser" }, { "name": "AmazonEC2ContainerRegistryReadOnly", "value": "arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly" }, { "name": "AmazonEC2ContainerServiceAutoscaleRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceAutoscaleRole" }, { "name": "AmazonEC2ContainerServiceEventsRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceEventsRole" }, { "name": "AmazonEC2ContainerServiceFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEC2ContainerServiceFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AmazonECS_FullAccess instead." }, { "name": "AmazonEC2ContainerServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceRole" }, { "name": "AmazonEC2ContainerServiceforEC2Role", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceforEC2Role" }, { "name": "AmazonEC2FullAccess", "value": "arn:aws:iam::aws:policy/AmazonEC2FullAccess" }, { "name": "AmazonEC2ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess" }, { "name": "AmazonEC2ReportsAccess", "value": "arn:aws:iam::aws:policy/AmazonEC2ReportsAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AmazonEC2RolePolicyForLaunchWizard", "value": "arn:aws:iam::aws:policy/AmazonEC2RolePolicyForLaunchWizard" }, { "name": "AmazonEC2RoleforAWSCodeDeploy", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforAWSCodeDeploy" }, { "name": "AmazonEC2RoleforAWSCodeDeployLimited", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforAWSCodeDeployLimited" }, { "name": "AmazonEC2RoleforDataPipelineRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforDataPipelineRole" }, { "name": "AmazonEC2RoleforSSM", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforSSM" }, { "name": "AmazonEC2SpotFleetAutoscaleRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2SpotFleetAutoscaleRole" }, { "name": "AmazonEC2SpotFleetRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2SpotFleetRole", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AmazonEC2SpotFleetTaggingRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonEC2SpotFleetTaggingRole" }, { "name": "AmazonECSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonECS_FullAccess" }, { "name": "AmazonECSInfrastructureRolePolicyForServiceConnectTransportLayerSecurity", "value": "arn:aws:iam::aws:policy/service-role/AmazonECSInfrastructureRolePolicyForServiceConnectTransportLayerSecurity" }, { "name": "AmazonECSInfrastructureRolePolicyForVolumes", "value": "arn:aws:iam::aws:policy/service-role/AmazonECSInfrastructureRolePolicyForVolumes" }, { "name": "AmazonECSServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonECSServiceRolePolicy" }, { "name": "AmazonECSTaskExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy" }, { "name": "AmazonEFSCSIDriverPolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonEFSCSIDriverPolicy" }, { "name": "AmazonEKSClusterPolicy", "value": "arn:aws:iam::aws:policy/AmazonEKSClusterPolicy" }, { "name": "AmazonEKSConnectorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEKSConnectorServiceRolePolicy" }, { "name": "AmazonEKSFargatePodExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy" }, { "name": "AmazonEKSForFargateServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEKSForFargateServiceRolePolicy" }, { "name": "AmazonEKSLocalOutpostClusterPolicy", "value": "arn:aws:iam::aws:policy/AmazonEKSLocalOutpostClusterPolicy" }, { "name": "AmazonEKSLocalOutpostServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEKSLocalOutpostServiceRolePolicy" }, { "name": "AmazonEKSServicePolicy", "value": "arn:aws:iam::aws:policy/AmazonEKSServicePolicy" }, { "name": "AmazonEKSServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEKSServiceRolePolicy" }, { "name": "AmazonEKSVPCResourceController", "value": "arn:aws:iam::aws:policy/AmazonEKSVPCResourceController" }, { "name": "AmazonEKSWorkerNodePolicy", "value": "arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy" }, { "name": "AmazonEKS_CNI_Policy", "value": "arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy" }, { "name": "AmazonEMRCleanupPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEMRCleanupPolicy" }, { "name": "AmazonEMRContainersServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEMRContainersServiceRolePolicy" }, { "name": "AmazonEMRFullAccessPolicy_v2", "value": "arn:aws:iam::aws:policy/AmazonEMRFullAccessPolicy_v2" }, { "name": "AmazonEMRReadOnlyAccessPolicy_v2", "value": "arn:aws:iam::aws:policy/AmazonEMRReadOnlyAccessPolicy_v2" }, { "name": "AmazonEMRServerlessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEMRServerlessServiceRolePolicy" }, { "name": "AmazonEMRServicePolicy_v2", "value": "arn:aws:iam::aws:policy/service-role/AmazonEMRServicePolicy_v2" }, { "name": "AmazonESCognitoAccess", "value": "arn:aws:iam::aws:policy/AmazonESCognitoAccess" }, { "name": "AmazonESFullAccess", "value": "arn:aws:iam::aws:policy/AmazonESFullAccess" }, { "name": "AmazonESReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonESReadOnlyAccess" }, { "name": "AmazonElastiCacheFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElastiCacheFullAccess" }, { "name": "AmazonElastiCacheReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElastiCacheReadOnlyAccess" }, { "name": "AmazonElasticContainerRegistryPublicFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticContainerRegistryPublicFullAccess" }, { "name": "AmazonElasticContainerRegistryPublicPowerUser", "value": "arn:aws:iam::aws:policy/AmazonElasticContainerRegistryPublicPowerUser" }, { "name": "AmazonElasticContainerRegistryPublicReadOnly", "value": "arn:aws:iam::aws:policy/AmazonElasticContainerRegistryPublicReadOnly" }, { "name": "AmazonElasticFileSystemClientFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemClientFullAccess" }, { "name": "AmazonElasticFileSystemClientReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemClientReadOnlyAccess" }, { "name": "AmazonElasticFileSystemClientReadWriteAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemClientReadWriteAccess" }, { "name": "AmazonElasticFileSystemFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemFullAccess" }, { "name": "AmazonElasticFileSystemReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemReadOnlyAccess" }, { "name": "AmazonElasticFileSystemServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonElasticFileSystemServiceRolePolicy" }, { "name": "AmazonElasticFileSystemsUtils", "value": "arn:aws:iam::aws:policy/AmazonElasticFileSystemsUtils" }, { "name": "AmazonElasticMapReduceEditorsRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonElasticMapReduceEditorsRole" }, { "name": "AmazonElasticMapReduceFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticMapReduceFullAccess" }, { "name": "AmazonElasticMapReducePlacementGroupPolicy", "value": "arn:aws:iam::aws:policy/AmazonElasticMapReducePlacementGroupPolicy" }, { "name": "AmazonElasticMapReduceReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticMapReduceReadOnlyAccess" }, { "name": "AmazonElasticMapReduceRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonElasticMapReduceRole" }, { "name": "AmazonElasticMapReduceforAutoScalingRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonElasticMapReduceforAutoScalingRole" }, { "name": "AmazonElasticMapReduceforEC2Role", "value": "arn:aws:iam::aws:policy/service-role/AmazonElasticMapReduceforEC2Role" }, { "name": "AmazonElasticTranscoderFullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoderFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use ElasticTranscoder_FullAccess instead." }, { "name": "AmazonElasticTranscoderJobsSubmitter", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoderJobsSubmitter", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use ElasticTranscoder_JobsSubmitter instead." }, { "name": "AmazonElasticTranscoderReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoderReadOnlyAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use ElasticTranscoder_ReadOnlyAccess instead." }, { "name": "AmazonElasticTranscoderRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonElasticTranscoderRole" }, { "name": "ElasticTranscoder_FullAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoder_FullAccess" }, { "name": "ElasticTranscoder_JobsSubmitter", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoder_JobsSubmitter" }, { "name": "ElasticTranscoder_ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonElasticTranscoder_ReadOnlyAccess" }, { "name": "AmazonElasticsearchServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonElasticsearchServiceRolePolicy" }, { "name": "AmazonEventBridgeApiDestinationsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEventBridgeApiDestinationsServiceRolePolicy" }, { "name": "AmazonEventBridgeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess" }, { "name": "AmazonEventBridgePipesFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgePipesFullAccess" }, { "name": "AmazonEventBridgePipesOperatorAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgePipesOperatorAccess" }, { "name": "AmazonEventBridgePipesReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgePipesReadOnlyAccess" }, { "name": "AmazonEventBridgeReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeReadOnlyAccess" }, { "name": "AmazonEventBridgeSchedulerFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeSchedulerFullAccess" }, { "name": "AmazonEventBridgeSchedulerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeSchedulerReadOnlyAccess" }, { "name": "AmazonEventBridgeSchemasFullAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeSchemasFullAccess" }, { "name": "AmazonEventBridgeSchemasReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonEventBridgeSchemasReadOnlyAccess" }, { "name": "AmazonEventBridgeSchemasServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonEventBridgeSchemasServiceRolePolicy" }, { "name": "AmazonFISServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonFISServiceRolePolicy" }, { "name": "AmazonFSxConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonFSxConsoleFullAccess" }, { "name": "AmazonFSxConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonFSxConsoleReadOnlyAccess" }, { "name": "AmazonFSxFullAccess", "value": "arn:aws:iam::aws:policy/AmazonFSxFullAccess" }, { "name": "AmazonFSxReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonFSxReadOnlyAccess" }, { "name": "AmazonFSxServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonFSxServiceRolePolicy" }, { "name": "AmazonForecastFullAccess", "value": "arn:aws:iam::aws:policy/AmazonForecastFullAccess" }, { "name": "AmazonFraudDetectorFullAccessPolicy", "value": "arn:aws:iam::aws:policy/AmazonFraudDetectorFullAccessPolicy" }, { "name": "AmazonFreeRTOSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonFreeRTOSFullAccess" }, { "name": "AmazonFreeRTOSOTAUpdate", "value": "arn:aws:iam::aws:policy/service-role/AmazonFreeRTOSOTAUpdate" }, { "name": "AmazonGlacierFullAccess", "value": "arn:aws:iam::aws:policy/AmazonGlacierFullAccess" }, { "name": "AmazonGlacierReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonGlacierReadOnlyAccess" }, { "name": "AmazonGrafanaAthenaAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonGrafanaAthenaAccess" }, { "name": "AmazonGrafanaCloudWatchAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonGrafanaCloudWatchAccess" }, { "name": "AmazonGrafanaRedshiftAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonGrafanaRedshiftAccess" }, { "name": "AmazonGrafanaServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonGrafanaServiceLinkedRolePolicy" }, { "name": "AmazonGuardDutyFullAccess", "value": "arn:aws:iam::aws:policy/AmazonGuardDutyFullAccess" }, { "name": "AmazonGuardDutyMalwareProtectionServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonGuardDutyMalwareProtectionServiceRolePolicy" }, { "name": "AmazonGuardDutyReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonGuardDutyReadOnlyAccess" }, { "name": "AmazonGuardDutyServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonGuardDutyServiceRolePolicy" }, { "name": "AmazonHealthLakeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonHealthLakeFullAccess" }, { "name": "AmazonHealthLakeReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonHealthLakeReadOnlyAccess" }, { "name": "AmazonHoneycodeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeFullAccess" }, { "name": "AmazonHoneycodeReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeReadOnlyAccess" }, { "name": "AmazonHoneycodeServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonHoneycodeServiceRolePolicy" }, { "name": "AmazonHoneycodeTeamAssociationFullAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeTeamAssociationFullAccess" }, { "name": "AmazonHoneycodeTeamAssociationReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeTeamAssociationReadOnlyAccess" }, { "name": "AmazonHoneycodeWorkbookFullAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeWorkbookFullAccess" }, { "name": "AmazonHoneycodeWorkbookReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonHoneycodeWorkbookReadOnlyAccess" }, { "name": "AmazonInspector2AgentlessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonInspector2AgentlessServiceRolePolicy" }, { "name": "AmazonInspector2FullAccess", "value": "arn:aws:iam::aws:policy/AmazonInspector2FullAccess" }, { "name": "AmazonInspector2ManagedCisPolicy", "value": "arn:aws:iam::aws:policy/AmazonInspector2ManagedCisPolicy" }, { "name": "AmazonInspector2ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonInspector2ReadOnlyAccess" }, { "name": "AmazonInspector2ServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonInspector2ServiceRolePolicy" }, { "name": "AmazonInspectorFullAccess", "value": "arn:aws:iam::aws:policy/AmazonInspectorFullAccess" }, { "name": "AmazonInspectorReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonInspectorReadOnlyAccess" }, { "name": "AmazonInspectorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonInspectorServiceRolePolicy" }, { "name": "AmazonKendraFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKendraFullAccess" }, { "name": "AmazonKendraReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonKendraReadOnlyAccess" }, { "name": "AmazonKeyspacesFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKeyspacesFullAccess" }, { "name": "AmazonKeyspacesReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonKeyspacesReadOnlyAccess" }, { "name": "AmazonKeyspacesReadOnlyAccess_v2", "value": "arn:aws:iam::aws:policy/AmazonKeyspacesReadOnlyAccess_v2" }, { "name": "AmazonKinesisAnalyticsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisAnalyticsFullAccess" }, { "name": "AmazonKinesisAnalyticsReadOnly", "value": "arn:aws:iam::aws:policy/AmazonKinesisAnalyticsReadOnly" }, { "name": "AmazonKinesisFirehoseFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisFirehoseFullAccess" }, { "name": "AmazonKinesisFirehoseReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisFirehoseReadOnlyAccess" }, { "name": "AmazonKinesisFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisFullAccess" }, { "name": "AmazonKinesisReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisReadOnlyAccess" }, { "name": "AmazonKinesisVideoStreamsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisVideoStreamsFullAccess" }, { "name": "AmazonKinesisVideoStreamsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonKinesisVideoStreamsReadOnlyAccess" }, { "name": "AmazonLaunchWizard_Fullaccess", "value": "arn:aws:iam::aws:policy/AmazonLaunchWizard_Fullaccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AmazonLaunchWizardFullAccessV2", "value": "arn:aws:iam::aws:policy/AmazonLaunchWizardFullAccessV2" }, { "name": "AmazonLexChannelsAccess", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonLexChannelsAccess" }, { "name": "AmazonLexFullAccess", "value": "arn:aws:iam::aws:policy/AmazonLexFullAccess" }, { "name": "AmazonLexReadOnly", "value": "arn:aws:iam::aws:policy/AmazonLexReadOnly" }, { "name": "AmazonLexReplicationPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonLexReplicationPolicy" }, { "name": "AmazonLexRunBotsOnly", "value": "arn:aws:iam::aws:policy/AmazonLexRunBotsOnly" }, { "name": "AmazonLexV2BotPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonLexV2BotPolicy" }, { "name": "AmazonLookoutEquipmentFullAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutEquipmentFullAccess" }, { "name": "AmazonLookoutEquipmentReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutEquipmentReadOnlyAccess" }, { "name": "AmazonLookoutMetricsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutMetricsFullAccess" }, { "name": "AmazonLookoutMetricsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutMetricsReadOnlyAccess" }, { "name": "AmazonLookoutVisionConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutVisionConsoleFullAccess" }, { "name": "AmazonLookoutVisionConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutVisionConsoleReadOnlyAccess" }, { "name": "AmazonLookoutVisionFullAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutVisionFullAccess" }, { "name": "AmazonLookoutVisionReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonLookoutVisionReadOnlyAccess" }, { "name": "AmazonMCSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMCSFullAccess" }, { "name": "AmazonMCSReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMCSReadOnlyAccess" }, { "name": "AmazonMQApiFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMQApiFullAccess" }, { "name": "AmazonMQApiReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMQApiReadOnlyAccess" }, { "name": "AmazonMQFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMQFullAccess" }, { "name": "AmazonMQReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMQReadOnlyAccess" }, { "name": "AmazonMQServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonMQServiceRolePolicy" }, { "name": "AmazonMSKConnectReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMSKConnectReadOnlyAccess" }, { "name": "AmazonMSKFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMSKFullAccess" }, { "name": "AmazonMSKReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMSKReadOnlyAccess" }, { "name": "AmazonMWAAServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonMWAAServiceRolePolicy" }, { "name": "AmazonMachineLearningBatchPredictionsAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningBatchPredictionsAccess" }, { "name": "AmazonMachineLearningCreateOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningCreateOnlyAccess" }, { "name": "AmazonMachineLearningFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningFullAccess" }, { "name": "AmazonMachineLearningManageRealTimeEndpointOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningManageRealTimeEndpointOnlyAccess" }, { "name": "AmazonMachineLearningReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningReadOnlyAccess" }, { "name": "AmazonMachineLearningRealTimePredictionOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMachineLearningRealTimePredictionOnlyAccess" }, { "name": "AmazonMachineLearningRoleforRedshiftDataSource", "value": "arn:aws:iam::aws:policy/service-role/AmazonMachineLearningRoleforRedshiftDataSource", "deprecationMessage": "This policy is deprecated. Use AmazonMachineLearningRoleforRedshiftDataSourceV3 instead." }, { "name": "AmazonMachineLearningRoleforRedshiftDataSourceV3", "value": "arn:aws:iam::aws:policy/service-role/AmazonMachineLearningRoleforRedshiftDataSourceV3" }, { "name": "AmazonMacieFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMacieFullAccess" }, { "name": "AmazonMacieHandshakeRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonMacieHandshakeRole" }, { "name": "AmazonMacieReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMacieReadOnlyAccess" }, { "name": "AmazonMacieServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonMacieServiceRole" }, { "name": "AmazonMacieServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonMacieServiceRolePolicy" }, { "name": "AmazonManagedBlockchainConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonManagedBlockchainConsoleFullAccess" }, { "name": "AmazonManagedBlockchainFullAccess", "value": "arn:aws:iam::aws:policy/AmazonManagedBlockchainFullAccess" }, { "name": "AmazonManagedBlockchainReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonManagedBlockchainReadOnlyAccess" }, { "name": "AmazonManagedBlockchainServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonManagedBlockchainServiceRolePolicy" }, { "name": "AmazonMechanicalTurkFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMechanicalTurkFullAccess" }, { "name": "AmazonMechanicalTurkReadOnly", "value": "arn:aws:iam::aws:policy/AmazonMechanicalTurkReadOnly" }, { "name": "AmazonMemoryDBFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMemoryDBFullAccess" }, { "name": "AmazonMemoryDBReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMemoryDBReadOnlyAccess" }, { "name": "AmazonMobileAnalyticsFinancialReportAccess", "value": "arn:aws:iam::aws:policy/AmazonMobileAnalyticsFinancialReportAccess" }, { "name": "AmazonMobileAnalyticsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMobileAnalyticsFullAccess" }, { "name": "AmazonMobileAnalyticsNonfinancialReportAccess", "value": "arn:aws:iam::aws:policy/AmazonMobileAnalyticsNon-financialReportAccess" }, { "name": "AmazonMobileAnalyticsWriteOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonMobileAnalyticsWriteOnlyAccess" }, { "name": "AmazonMonitronFullAccess", "value": "arn:aws:iam::aws:policy/AmazonMonitronFullAccess" }, { "name": "AmazonNimbleStudioLaunchProfileWorker", "value": "arn:aws:iam::aws:policy/AmazonNimbleStudio-LaunchProfileWorker" }, { "name": "AmazonNimbleStudioStudioAdmin", "value": "arn:aws:iam::aws:policy/AmazonNimbleStudio-StudioAdmin" }, { "name": "AmazonNimbleStudioStudioUser", "value": "arn:aws:iam::aws:policy/AmazonNimbleStudio-StudioUser" }, { "name": "AmazonOmicsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonOmicsFullAccess" }, { "name": "AmazonOmicsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonOmicsReadOnlyAccess" }, { "name": "AmazonOneEnterpriseFullAccess", "value": "arn:aws:iam::aws:policy/AmazonOneEnterpriseFullAccess" }, { "name": "AmazonOneEnterpriseInstallerAccess", "value": "arn:aws:iam::aws:policy/AmazonOneEnterpriseInstallerAccess" }, { "name": "AmazonOneEnterpriseReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonOneEnterpriseReadOnlyAccess" }, { "name": "AmazonOpenSearchDashboardsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonOpenSearchDashboardsServiceRolePolicy" }, { "name": "AmazonOpenSearchIngestionFullAccess", "value": "arn:aws:iam::aws:policy/AmazonOpenSearchIngestionFullAccess" }, { "name": "AmazonOpenSearchIngestionReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonOpenSearchIngestionReadOnlyAccess" }, { "name": "AmazonOpenSearchIngestionServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonOpenSearchIngestionServiceRolePolicy" }, { "name": "AmazonOpenSearchServerlessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonOpenSearchServerlessServiceRolePolicy" }, { "name": "AmazonOpenSearchServiceCognitoAccess", "value": "arn:aws:iam::aws:policy/AmazonOpenSearchServiceCognitoAccess" }, { "name": "AmazonOpenSearchServiceFullAccess", "value": "arn:aws:iam::aws:policy/AmazonOpenSearchServiceFullAccess" }, { "name": "AmazonOpenSearchServiceReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonOpenSearchServiceReadOnlyAccess" }, { "name": "AmazonOpenSearchServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonOpenSearchServiceRolePolicy" }, { "name": "AmazonPersonalizeFullAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonPersonalizeFullAccess" }, { "name": "AmazonPollyFullAccess", "value": "arn:aws:iam::aws:policy/AmazonPollyFullAccess" }, { "name": "AmazonPollyReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonPollyReadOnlyAccess" }, { "name": "AmazonPrometheusConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonPrometheusConsoleFullAccess" }, { "name": "AmazonPrometheusFullAccess", "value": "arn:aws:iam::aws:policy/AmazonPrometheusFullAccess" }, { "name": "AmazonPrometheusQueryAccess", "value": "arn:aws:iam::aws:policy/AmazonPrometheusQueryAccess" }, { "name": "AmazonPrometheusRemoteWriteAccess", "value": "arn:aws:iam::aws:policy/AmazonPrometheusRemoteWriteAccess" }, { "name": "AmazonPrometheusScraperServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonPrometheusScraperServiceRolePolicy" }, { "name": "AmazonQFullAccess", "value": "arn:aws:iam::aws:policy/AmazonQFullAccess" }, { "name": "AmazonQLDBConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonQLDBConsoleFullAccess" }, { "name": "AmazonQLDBFullAccess", "value": "arn:aws:iam::aws:policy/AmazonQLDBFullAccess" }, { "name": "AmazonQLDBReadOnly", "value": "arn:aws:iam::aws:policy/AmazonQLDBReadOnly" }, { "name": "AmazonRDSBetaServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRDSBetaServiceRolePolicy" }, { "name": "AmazonRDSCustomInstanceProfileRolePolicy", "value": "arn:aws:iam::aws:policy/AmazonRDSCustomInstanceProfileRolePolicy" }, { "name": "AmazonRDSCustomPreviewServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRDSCustomPreviewServiceRolePolicy" }, { "name": "AmazonRDSCustomServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRDSCustomServiceRolePolicy" }, { "name": "AmazonRDSDataFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRDSDataFullAccess" }, { "name": "AmazonRDSDirectoryServiceAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonRDSDirectoryServiceAccess" }, { "name": "AmazonRDSEnhancedMonitoringRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" }, { "name": "AmazonRDSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRDSFullAccess" }, { "name": "AmazonRDSPerformanceInsightsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRDSPerformanceInsightsFullAccess" }, { "name": "AmazonRDSPerformanceInsightsReadOnly", "value": "arn:aws:iam::aws:policy/AmazonRDSPerformanceInsightsReadOnly" }, { "name": "AmazonRDSPreviewServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRDSPreviewServiceRolePolicy" }, { "name": "AmazonRDSReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRDSReadOnlyAccess" }, { "name": "AmazonRDSServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRDSServiceRolePolicy" }, { "name": "AmazonRedshiftAllCommandsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRedshiftAllCommandsFullAccess" }, { "name": "AmazonRedshiftDataFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRedshiftDataFullAccess" }, { "name": "AmazonRedshiftFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRedshiftFullAccess" }, { "name": "AmazonRedshiftQueryEditor", "value": "arn:aws:iam::aws:policy/AmazonRedshiftQueryEditor" }, { "name": "AmazonRedshiftQueryEditorV2FullAccess", "value": "arn:aws:iam::aws:policy/AmazonRedshiftQueryEditorV2FullAccess" }, { "name": "AmazonRedshiftQueryEditorV2NoSharing", "value": "arn:aws:iam::aws:policy/AmazonRedshiftQueryEditorV2NoSharing" }, { "name": "AmazonRedshiftQueryEditorV2ReadSharing", "value": "arn:aws:iam::aws:policy/AmazonRedshiftQueryEditorV2ReadSharing" }, { "name": "AmazonRedshiftQueryEditorV2ReadWriteSharing", "value": "arn:aws:iam::aws:policy/AmazonRedshiftQueryEditorV2ReadWriteSharing" }, { "name": "AmazonRedshiftReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRedshiftReadOnlyAccess" }, { "name": "AmazonRedshiftServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonRedshiftServiceLinkedRolePolicy" }, { "name": "AmazonRekognitionCustomLabelsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRekognitionCustomLabelsFullAccess" }, { "name": "AmazonRekognitionFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRekognitionFullAccess" }, { "name": "AmazonRekognitionReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRekognitionReadOnlyAccess" }, { "name": "AmazonRekognitionServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonRekognitionServiceRole" }, { "name": "AmazonRoute53AutoNamingFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53AutoNamingFullAccess" }, { "name": "AmazonRoute53AutoNamingReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53AutoNamingReadOnlyAccess" }, { "name": "AmazonRoute53AutoNamingRegistrantAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53AutoNamingRegistrantAccess" }, { "name": "AmazonRoute53DomainsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53DomainsFullAccess" }, { "name": "AmazonRoute53DomainsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53DomainsReadOnlyAccess" }, { "name": "AmazonRoute53FullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53FullAccess" }, { "name": "AmazonRoute53ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53ReadOnlyAccess" }, { "name": "AmazonRoute53RecoveryClusterFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryClusterFullAccess" }, { "name": "AmazonRoute53RecoveryClusterReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryClusterReadOnlyAccess" }, { "name": "AmazonRoute53RecoveryControlConfigFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryControlConfigFullAccess" }, { "name": "AmazonRoute53RecoveryControlConfigReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryControlConfigReadOnlyAccess" }, { "name": "AmazonRoute53RecoveryReadinessFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryReadinessFullAccess" }, { "name": "AmazonRoute53RecoveryReadinessReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53RecoveryReadinessReadOnlyAccess" }, { "name": "AmazonRoute53ResolverFullAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53ResolverFullAccess" }, { "name": "AmazonRoute53ResolverReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonRoute53ResolverReadOnlyAccess" }, { "name": "AmazonS3FullAccess", "value": "arn:aws:iam::aws:policy/AmazonS3FullAccess" }, { "name": "AmazonS3ObjectLambdaExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonS3ObjectLambdaExecutionRolePolicy" }, { "name": "AmazonS3OutpostsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonS3OutpostsFullAccess" }, { "name": "AmazonS3OutpostsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonS3OutpostsReadOnlyAccess" }, { "name": "AmazonS3ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess" }, { "name": "AmazonSESFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSESFullAccess" }, { "name": "AmazonSESReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonSESReadOnlyAccess" }, { "name": "AmazonSNSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSNSFullAccess" }, { "name": "AmazonSNSReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonSNSReadOnlyAccess" }, { "name": "AmazonSNSRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonSNSRole" }, { "name": "AmazonSQSFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSQSFullAccess" }, { "name": "AmazonSQSReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonSQSReadOnlyAccess" }, { "name": "AmazonSSMAutomationApproverAccess", "value": "arn:aws:iam::aws:policy/AmazonSSMAutomationApproverAccess" }, { "name": "AmazonSSMAutomationRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonSSMAutomationRole" }, { "name": "AmazonSSMDirectoryServiceAccess", "value": "arn:aws:iam::aws:policy/AmazonSSMDirectoryServiceAccess" }, { "name": "AmazonSSMFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSSMFullAccess" }, { "name": "AmazonSSMMaintenanceWindowRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonSSMMaintenanceWindowRole" }, { "name": "AmazonSSMManagedEC2InstanceDefaultPolicy", "value": "arn:aws:iam::aws:policy/AmazonSSMManagedEC2InstanceDefaultPolicy" }, { "name": "AmazonSSMManagedInstanceCore", "value": "arn:aws:iam::aws:policy/AmazonSSMManagedInstanceCore" }, { "name": "AmazonSSMPatchAssociation", "value": "arn:aws:iam::aws:policy/AmazonSSMPatchAssociation" }, { "name": "AmazonSSMReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonSSMReadOnlyAccess" }, { "name": "AmazonSSMServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonSSMServiceRolePolicy" }, { "name": "AmazonSageMakerAdminServiceCatalogProductsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/AmazonSageMakerAdmin-ServiceCatalogProductsServiceRolePolicy" }, { "name": "AmazonSageMakerCanvasAIServicesAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerCanvasAIServicesAccess" }, { "name": "AmazonSageMakerCanvasBedrockAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerCanvasBedrockAccess" }, { "name": "AmazonSageMakerCanvasDataPrepFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerCanvasDataPrepFullAccess" }, { "name": "AmazonSageMakerCanvasDirectDeployAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerCanvasDirectDeployAccess" }, { "name": "AmazonSageMakerCanvasForecastAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerCanvasForecastAccess" }, { "name": "AmazonSageMakerCanvasFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerCanvasFullAccess" }, { "name": "AmazonSageMakerClusterInstanceRolePolicy", "value": "arn:aws:iam::aws:policy/AmazonSageMakerClusterInstanceRolePolicy" }, { "name": "AmazonSageMakerCoreServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonSageMakerCoreServiceRolePolicy" }, { "name": "AmazonSageMakerEdgeDeviceFleetPolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerEdgeDeviceFleetPolicy" }, { "name": "AmazonSageMakerFeatureStoreAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerFeatureStoreAccess" }, { "name": "AmazonSageMakerFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerFullAccess" }, { "name": "AmazonSageMakerGeospatialExecutionRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerGeospatialExecutionRole" }, { "name": "AmazonSageMakerGeospatialFullAccess", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerGeospatialFullAccess" }, { "name": "AmazonSageMakerGroundTruthExecution", "value": "arn:aws:iam::aws:policy/AmazonSageMakerGroundTruthExecution" }, { "name": "AmazonSageMakerMechanicalTurkAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerMechanicalTurkAccess" }, { "name": "AmazonSageMakerModelGovernanceUseAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerModelGovernanceUseAccess" }, { "name": "AmazonSageMakerModelRegistryFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSageMakerModelRegistryFullAccess" }, { "name": "AmazonSageMakerNotebooksServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonSageMakerNotebooksServiceRolePolicy" }, { "name": "AmazonSageMakerPartnerServiceCatalogProductsApiGatewayServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerPartnerServiceCatalogProductsApiGatewayServiceRolePolicy" }, { "name": "AmazonSageMakerPartnerServiceCatalogProductsCloudFormationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerPartnerServiceCatalogProductsCloudFormationServiceRolePolicy" }, { "name": "AmazonSageMakerPartnerServiceCatalogProductsLambdaServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerPartnerServiceCatalogProductsLambdaServiceRolePolicy" }, { "name": "AmazonSageMakerPipelinesIntegrations", "value": "arn:aws:iam::aws:policy/AmazonSageMakerPipelinesIntegrations" }, { "name": "AmazonSageMakerReadOnly", "value": "arn:aws:iam::aws:policy/AmazonSageMakerReadOnly" }, { "name": "AmazonSageMakerServiceCatalogProductsApiGatewayServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsApiGatewayServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsCloudformationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsCloudformationServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsCodeBuildServiceRolePolicy", "value": "arn:aws:iam::aws:policy/AmazonSageMakerServiceCatalogProductsCodeBuildServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsCodePipelineServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsCodePipelineServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsEventsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsEventsServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsFirehoseServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsFirehoseServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsGlueServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsGlueServiceRolePolicy" }, { "name": "AmazonSageMakerServiceCatalogProductsLambdaServiceRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/AmazonSageMakerServiceCatalogProductsLambdaServiceRolePolicy" }, { "name": "AmazonSecurityLakeAdministrator", "value": "arn:aws:iam::aws:policy/AmazonSecurityLakeAdministrator" }, { "name": "AmazonSecurityLakeMetastoreManager", "value": "arn:aws:iam::aws:policy/service-role/AmazonSecurityLakeMetastoreManager" }, { "name": "AmazonSecurityLakePermissionsBoundary", "value": "arn:aws:iam::aws:policy/AmazonSecurityLakePermissionsBoundary" }, { "name": "AmazonSumerianFullAccess", "value": "arn:aws:iam::aws:policy/AmazonSumerianFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "AmazonTextractFullAccess", "value": "arn:aws:iam::aws:policy/AmazonTextractFullAccess" }, { "name": "AmazonTextractServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AmazonTextractServiceRole" }, { "name": "AmazonTimestreamConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AmazonTimestreamConsoleFullAccess" }, { "name": "AmazonTimestreamFullAccess", "value": "arn:aws:iam::aws:policy/AmazonTimestreamFullAccess" }, { "name": "AmazonTimestreamInfluxDBFullAccess", "value": "arn:aws:iam::aws:policy/AmazonTimestreamInfluxDBFullAccess" }, { "name": "AmazonTimestreamInfluxDBServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonTimestreamInfluxDBServiceRolePolicy" }, { "name": "AmazonTimestreamReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonTimestreamReadOnlyAccess" }, { "name": "AmazonTranscribeFullAccess", "value": "arn:aws:iam::aws:policy/AmazonTranscribeFullAccess" }, { "name": "AmazonTranscribeReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonTranscribeReadOnlyAccess" }, { "name": "AmazonVPCCrossAccountNetworkInterfaceOperations", "value": "arn:aws:iam::aws:policy/AmazonVPCCrossAccountNetworkInterfaceOperations" }, { "name": "AmazonVPCFullAccess", "value": "arn:aws:iam::aws:policy/AmazonVPCFullAccess" }, { "name": "AmazonVPCNetworkAccessAnalyzerFullAccessPolicy", "value": "arn:aws:iam::aws:policy/AmazonVPCNetworkAccessAnalyzerFullAccessPolicy" }, { "name": "AmazonVPCReachabilityAnalyzerFullAccessPolicy", "value": "arn:aws:iam::aws:policy/AmazonVPCReachabilityAnalyzerFullAccessPolicy" }, { "name": "AmazonVPCReachabilityAnalyzerPathComponentReadPolicy", "value": "arn:aws:iam::aws:policy/AmazonVPCReachabilityAnalyzerPathComponentReadPolicy" }, { "name": "AmazonVPCReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonVPCReadOnlyAccess" }, { "name": "AmazonWorkDocsFullAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkDocsFullAccess" }, { "name": "AmazonWorkDocsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkDocsReadOnlyAccess" }, { "name": "AmazonWorkMailEventsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonWorkMailEventsServiceRolePolicy" }, { "name": "AmazonWorkMailFullAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkMailFullAccess" }, { "name": "AmazonWorkMailMessageFlowFullAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkMailMessageFlowFullAccess" }, { "name": "AmazonWorkMailMessageFlowReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkMailMessageFlowReadOnlyAccess" }, { "name": "AmazonWorkMailReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkMailReadOnlyAccess" }, { "name": "AmazonWorkSpacesAdmin", "value": "arn:aws:iam::aws:policy/AmazonWorkSpacesAdmin" }, { "name": "AmazonWorkSpacesApplicationManagerAdminAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkSpacesApplicationManagerAdminAccess" }, { "name": "AmazonWorkSpacesSelfServiceAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkSpacesSelfServiceAccess" }, { "name": "AmazonWorkSpacesServiceAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkSpacesServiceAccess" }, { "name": "AmazonWorkSpacesWebReadOnly", "value": "arn:aws:iam::aws:policy/AmazonWorkSpacesWebReadOnly" }, { "name": "AmazonWorkSpacesWebServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AmazonWorkSpacesWebServiceRolePolicy" }, { "name": "AmazonWorkspacesPCAAccess", "value": "arn:aws:iam::aws:policy/AmazonWorkspacesPCAAccess" }, { "name": "AmazonZocaloFullAccess", "value": "arn:aws:iam::aws:policy/AmazonZocaloFullAccess" }, { "name": "AmazonZocaloReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AmazonZocaloReadOnlyAccess" }, { "name": "AmplifyBackendDeployFullAccess", "value": "arn:aws:iam::aws:policy/service-role/AmplifyBackendDeployFullAccess" }, { "name": "AppIntegrationsServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AppIntegrationsServiceLinkedRolePolicy" }, { "name": "AppRunnerNetworkingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AppRunnerNetworkingServiceRolePolicy" }, { "name": "AppRunnerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AppRunnerServiceRolePolicy" }, { "name": "ApplicationAutoScalingForAmazonAppStreamAccess", "value": "arn:aws:iam::aws:policy/service-role/ApplicationAutoScalingForAmazonAppStreamAccess" }, { "name": "ApplicationDiscoveryServiceContinuousExportServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ApplicationDiscoveryServiceContinuousExportServiceRolePolicy" }, { "name": "AutoScalingConsoleFullAccess", "value": "arn:aws:iam::aws:policy/AutoScalingConsoleFullAccess" }, { "name": "AutoScalingConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AutoScalingConsoleReadOnlyAccess" }, { "name": "AutoScalingFullAccess", "value": "arn:aws:iam::aws:policy/AutoScalingFullAccess" }, { "name": "AutoScalingNotificationAccessRole", "value": "arn:aws:iam::aws:policy/service-role/AutoScalingNotificationAccessRole" }, { "name": "AutoScalingReadOnlyAccess", "value": "arn:aws:iam::aws:policy/AutoScalingReadOnlyAccess" }, { "name": "AutoScalingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/AutoScalingServiceRolePolicy" }, { "name": "AwsGlueDataBrewFullAccessPolicy", "value": "arn:aws:iam::aws:policy/AwsGlueDataBrewFullAccessPolicy" }, { "name": "AwsGlueSessionUserRestrictedNotebookPolicy", "value": "arn:aws:iam::aws:policy/AwsGlueSessionUserRestrictedNotebookPolicy" }, { "name": "AwsGlueSessionUserRestrictedNotebookServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AwsGlueSessionUserRestrictedNotebookServiceRole" }, { "name": "AwsGlueSessionUserRestrictedPolicy", "value": "arn:aws:iam::aws:policy/AwsGlueSessionUserRestrictedPolicy" }, { "name": "AwsGlueSessionUserRestrictedServiceRole", "value": "arn:aws:iam::aws:policy/service-role/AwsGlueSessionUserRestrictedServiceRole" }, { "name": "BatchServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/BatchServiceRolePolicy" }, { "name": "Billing", "value": "arn:aws:iam::aws:policy/job-function/Billing" }, { "name": "CertificateManagerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CertificateManagerServiceRolePolicy" }, { "name": "ClientVPNServiceConnectionsRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ClientVPNServiceConnectionsRolePolicy" }, { "name": "ClientVPNServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ClientVPNServiceRolePolicy" }, { "name": "CloudFormationStackSetsOrgAdminServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudFormationStackSetsOrgAdminServiceRolePolicy" }, { "name": "CloudFormationStackSetsOrgMemberServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudFormationStackSetsOrgMemberServiceRolePolicy" }, { "name": "CloudFrontFullAccess", "value": "arn:aws:iam::aws:policy/CloudFrontFullAccess" }, { "name": "CloudFrontReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudFrontReadOnlyAccess" }, { "name": "CloudHSMServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudHSMServiceRolePolicy" }, { "name": "CloudSearchFullAccess", "value": "arn:aws:iam::aws:policy/CloudSearchFullAccess" }, { "name": "CloudSearchReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudSearchReadOnlyAccess" }, { "name": "CloudTrailServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudTrailServiceRolePolicy" }, { "name": "CloudWatchCrossAccountAccess", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudWatch-CrossAccountAccess" }, { "name": "CloudWatchActionsEC2Access", "value": "arn:aws:iam::aws:policy/CloudWatchActionsEC2Access" }, { "name": "CloudWatchAgentAdminPolicy", "value": "arn:aws:iam::aws:policy/CloudWatchAgentAdminPolicy" }, { "name": "CloudWatchAgentServerPolicy", "value": "arn:aws:iam::aws:policy/CloudWatchAgentServerPolicy" }, { "name": "CloudWatchApplicationInsightsFullAccess", "value": "arn:aws:iam::aws:policy/CloudWatchApplicationInsightsFullAccess" }, { "name": "CloudWatchApplicationInsightsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudWatchApplicationInsightsReadOnlyAccess" }, { "name": "CloudWatchApplicationSignalsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudWatchApplicationSignalsServiceRolePolicy" }, { "name": "CloudWatchAutomaticDashboardsAccess", "value": "arn:aws:iam::aws:policy/CloudWatchAutomaticDashboardsAccess" }, { "name": "CloudWatchCrossAccountSharingConfiguration", "value": "arn:aws:iam::aws:policy/CloudWatchCrossAccountSharingConfiguration" }, { "name": "CloudWatchEventsBuiltInTargetExecutionAccess", "value": "arn:aws:iam::aws:policy/service-role/CloudWatchEventsBuiltInTargetExecutionAccess" }, { "name": "CloudWatchEventsFullAccess", "value": "arn:aws:iam::aws:policy/CloudWatchEventsFullAccess" }, { "name": "CloudWatchEventsInvocationAccess", "value": "arn:aws:iam::aws:policy/service-role/CloudWatchEventsInvocationAccess" }, { "name": "CloudWatchEventsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudWatchEventsReadOnlyAccess" }, { "name": "CloudWatchEventsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudWatchEventsServiceRolePolicy" }, { "name": "CloudWatchFullAccess", "value": "arn:aws:iam::aws:policy/CloudWatchFullAccess" }, { "name": "CloudWatchFullAccessV2", "value": "arn:aws:iam::aws:policy/CloudWatchFullAccessV2" }, { "name": "CloudWatchInternetMonitorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudWatchInternetMonitorServiceRolePolicy" }, { "name": "CloudWatchLambdaInsightsExecutionRolePolicy", "value": "arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy" }, { "name": "CloudWatchLogsCrossAccountSharingConfiguration", "value": "arn:aws:iam::aws:policy/CloudWatchLogsCrossAccountSharingConfiguration" }, { "name": "CloudWatchLogsFullAccess", "value": "arn:aws:iam::aws:policy/CloudWatchLogsFullAccess" }, { "name": "CloudWatchLogsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudWatchLogsReadOnlyAccess" }, { "name": "CloudWatchNetworkMonitorServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudWatchNetworkMonitorServiceRolePolicy" }, { "name": "CloudWatchReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudWatchReadOnlyAccess" }, { "name": "CloudWatchSyntheticsFullAccess", "value": "arn:aws:iam::aws:policy/CloudWatchSyntheticsFullAccess" }, { "name": "CloudWatchSyntheticsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CloudWatchSyntheticsReadOnlyAccess" }, { "name": "CloudwatchApplicationInsightsServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CloudwatchApplicationInsightsServiceLinkedRolePolicy" }, { "name": "ComprehendDataAccessRolePolicy", "value": "arn:aws:iam::aws:policy/service-role/ComprehendDataAccessRolePolicy" }, { "name": "ComprehendFullAccess", "value": "arn:aws:iam::aws:policy/ComprehendFullAccess" }, { "name": "ComprehendMedicalFullAccess", "value": "arn:aws:iam::aws:policy/ComprehendMedicalFullAccess" }, { "name": "ComprehendReadOnly", "value": "arn:aws:iam::aws:policy/ComprehendReadOnly" }, { "name": "ComputeOptimizerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ComputeOptimizerReadOnlyAccess" }, { "name": "ComputeOptimizerServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ComputeOptimizerServiceRolePolicy" }, { "name": "ConfigConformsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ConfigConformsServiceRolePolicy" }, { "name": "CostOptimizationHubAdminAccess", "value": "arn:aws:iam::aws:policy/CostOptimizationHubAdminAccess" }, { "name": "CostOptimizationHubReadOnlyAccess", "value": "arn:aws:iam::aws:policy/CostOptimizationHubReadOnlyAccess" }, { "name": "CostOptimizationHubServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CostOptimizationHubServiceRolePolicy" }, { "name": "CustomerProfilesServiceLinkedRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/CustomerProfilesServiceLinkedRolePolicy" }, { "name": "DAXServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/DAXServiceRolePolicy" }, { "name": "DataScientist", "value": "arn:aws:iam::aws:policy/job-function/DataScientist" }, { "name": "DatabaseAdministrator", "value": "arn:aws:iam::aws:policy/job-function/DatabaseAdministrator" }, { "name": "DynamoDBCloudWatchContributorInsightsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/DynamoDBCloudWatchContributorInsightsServiceRolePolicy" }, { "name": "DynamoDBKinesisReplicationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/DynamoDBKinesisReplicationServiceRolePolicy" }, { "name": "DynamoDBReplicationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/DynamoDBReplicationServiceRolePolicy" }, { "name": "EC2FastLaunchServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/EC2FastLaunchServiceRolePolicy" }, { "name": "EC2FleetTimeShiftableServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/EC2FleetTimeShiftableServiceRolePolicy" }, { "name": "EC2ImageBuilderLifecycleExecutionPolicy", "value": "arn:aws:iam::aws:policy/service-role/EC2ImageBuilderLifecycleExecutionPolicy" }, { "name": "EC2InstanceConnect", "value": "arn:aws:iam::aws:policy/EC2InstanceConnect" }, { "name": "EC2InstanceProfileForImageBuilder", "value": "arn:aws:iam::aws:policy/EC2InstanceProfileForImageBuilder" }, { "name": "EC2InstanceProfileForImageBuilderECRContainerBuilds", "value": "arn:aws:iam::aws:policy/EC2InstanceProfileForImageBuilderECRContainerBuilds" }, { "name": "ECRReplicationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ECRReplicationServiceRolePolicy" }, { "name": "EMRDescribeClusterPolicyForEMRWAL", "value": "arn:aws:iam::aws:policy/aws-service-role/EMRDescribeClusterPolicyForEMRWAL" }, { "name": "Ec2ImageBuilderCrossAccountDistributionAccess", "value": "arn:aws:iam::aws:policy/Ec2ImageBuilderCrossAccountDistributionAccess" }, { "name": "Ec2InstanceConnectEndpoint", "value": "arn:aws:iam::aws:policy/aws-service-role/Ec2InstanceConnectEndpoint" }, { "name": "ElastiCacheServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ElastiCacheServiceRolePolicy" }, { "name": "ElasticLoadBalancingFullAccess", "value": "arn:aws:iam::aws:policy/ElasticLoadBalancingFullAccess" }, { "name": "ElasticLoadBalancingReadOnly", "value": "arn:aws:iam::aws:policy/ElasticLoadBalancingReadOnly" }, { "name": "ElementalActivationsDownloadSoftwareAccess", "value": "arn:aws:iam::aws:policy/ElementalActivationsDownloadSoftwareAccess" }, { "name": "ElementalActivationsFullAccess", "value": "arn:aws:iam::aws:policy/ElementalActivationsFullAccess" }, { "name": "ElementalActivationsGenerateLicenses", "value": "arn:aws:iam::aws:policy/ElementalActivationsGenerateLicenses" }, { "name": "ElementalActivationsReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ElementalActivationsReadOnlyAccess" }, { "name": "ElementalAppliancesSoftwareFullAccess", "value": "arn:aws:iam::aws:policy/ElementalAppliancesSoftwareFullAccess" }, { "name": "ElementalAppliancesSoftwareReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ElementalAppliancesSoftwareReadOnlyAccess" }, { "name": "ElementalSupportCenterFullAccess", "value": "arn:aws:iam::aws:policy/ElementalSupportCenterFullAccess" }, { "name": "FMSServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/FMSServiceRolePolicy" }, { "name": "FSxDeleteServiceLinkedRoleAccess", "value": "arn:aws:iam::aws:policy/aws-service-role/FSxDeleteServiceLinkedRoleAccess" }, { "name": "FusionDevInternalServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/FusionDevInternalServiceRolePolicy", "deprecationMessage": "This policy is deprecated and will be removed in a future release." }, { "name": "GameLiftGameServerGroupPolicy", "value": "arn:aws:iam::aws:policy/GameLiftGameServerGroupPolicy" }, { "name": "GlobalAcceleratorFullAccess", "value": "arn:aws:iam::aws:policy/GlobalAcceleratorFullAccess" }, { "name": "GlobalAcceleratorReadOnlyAccess", "value": "arn:aws:iam::aws:policy/GlobalAcceleratorReadOnlyAccess" }, { "name": "GreengrassOTAUpdateArtifactAccess", "value": "arn:aws:iam::aws:policy/service-role/GreengrassOTAUpdateArtifactAccess" }, { "name": "GroundTruthSyntheticConsoleFullAccess", "value": "arn:aws:iam::aws:policy/GroundTruthSyntheticConsoleFullAccess" }, { "name": "GroundTruthSyntheticConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/GroundTruthSyntheticConsoleReadOnlyAccess" }, { "name": "Health_OrganizationsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/Health_OrganizationsServiceRolePolicy" }, { "name": "IAMAccessAdvisorReadOnly", "value": "arn:aws:iam::aws:policy/IAMAccessAdvisorReadOnly" }, { "name": "IAMAccessAnalyzerFullAccess", "value": "arn:aws:iam::aws:policy/IAMAccessAnalyzerFullAccess" }, { "name": "IAMAccessAnalyzerReadOnlyAccess", "value": "arn:aws:iam::aws:policy/IAMAccessAnalyzerReadOnlyAccess" }, { "name": "IAMFullAccess", "value": "arn:aws:iam::aws:policy/IAMFullAccess" }, { "name": "IAMReadOnlyAccess", "value": "arn:aws:iam::aws:policy/IAMReadOnlyAccess" }, { "name": "IAMSelfManageServiceSpecificCredentials", "value": "arn:aws:iam::aws:policy/IAMSelfManageServiceSpecificCredentials" }, { "name": "IAMUserChangePassword", "value": "arn:aws:iam::aws:policy/IAMUserChangePassword" }, { "name": "IAMUserSSHKeys", "value": "arn:aws:iam::aws:policy/IAMUserSSHKeys" }, { "name": "IVSFullAccess", "value": "arn:aws:iam::aws:policy/IVSFullAccess" }, { "name": "IVSReadOnlyAccess", "value": "arn:aws:iam::aws:policy/IVSReadOnlyAccess" }, { "name": "IVSRecordToS3", "value": "arn:aws:iam::aws:policy/aws-service-role/IVSRecordToS3" }, { "name": "KafkaConnectServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/KafkaConnectServiceRolePolicy" }, { "name": "KafkaServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/KafkaServiceRolePolicy" }, { "name": "KeyspacesReplicationServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/KeyspacesReplicationServiceRolePolicy" }, { "name": "LakeFormationDataAccessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/LakeFormationDataAccessServiceRolePolicy" }, { "name": "LexBotPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/LexBotPolicy" }, { "name": "LexChannelPolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/LexChannelPolicy" }, { "name": "LightsailExportAccess", "value": "arn:aws:iam::aws:policy/aws-service-role/LightsailExportAccess" }, { "name": "MediaConnectGatewayInstanceRolePolicy", "value": "arn:aws:iam::aws:policy/MediaConnectGatewayInstanceRolePolicy" }, { "name": "MediaPackageServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MediaPackageServiceRolePolicy" }, { "name": "MemoryDBServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MemoryDBServiceRolePolicy" }, { "name": "MigrationHubDMSAccessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MigrationHubDMSAccessServiceRolePolicy" }, { "name": "MigrationHubSMSAccessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MigrationHubSMSAccessServiceRolePolicy" }, { "name": "MigrationHubServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MigrationHubServiceRolePolicy" }, { "name": "MonitronServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/MonitronServiceRolePolicy" }, { "name": "NeptuneConsoleFullAccess", "value": "arn:aws:iam::aws:policy/NeptuneConsoleFullAccess" }, { "name": "NeptuneFullAccess", "value": "arn:aws:iam::aws:policy/NeptuneFullAccess" }, { "name": "NeptuneGraphReadOnlyAccess", "value": "arn:aws:iam::aws:policy/NeptuneGraphReadOnlyAccess" }, { "name": "NeptuneReadOnlyAccess", "value": "arn:aws:iam::aws:policy/NeptuneReadOnlyAccess" }, { "name": "NetworkAdministrator", "value": "arn:aws:iam::aws:policy/job-function/NetworkAdministrator" }, { "name": "OAMFullAccess", "value": "arn:aws:iam::aws:policy/OAMFullAccess" }, { "name": "OAMReadOnlyAccess", "value": "arn:aws:iam::aws:policy/OAMReadOnlyAccess" }, { "name": "PartnerCentralAccountManagementUserRoleAssociation", "value": "arn:aws:iam::aws:policy/PartnerCentralAccountManagementUserRoleAssociation" }, { "name": "PowerUserAccess", "value": "arn:aws:iam::aws:policy/PowerUserAccess" }, { "name": "QuickSightAccessForS3StorageManagementAnalyticsReadOnly", "value": "arn:aws:iam::aws:policy/service-role/QuickSightAccessForS3StorageManagementAnalyticsReadOnly" }, { "name": "RDSCloudHsmAuthorizationRole", "value": "arn:aws:iam::aws:policy/service-role/RDSCloudHsmAuthorizationRole" }, { "name": "ROSAAmazonEBSCSIDriverOperatorPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAAmazonEBSCSIDriverOperatorPolicy" }, { "name": "ROSACloudNetworkConfigOperatorPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSACloudNetworkConfigOperatorPolicy" }, { "name": "ROSAControlPlaneOperatorPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAControlPlaneOperatorPolicy" }, { "name": "ROSAImageRegistryOperatorPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAImageRegistryOperatorPolicy" }, { "name": "ROSAIngressOperatorPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAIngressOperatorPolicy" }, { "name": "ROSAInstallerPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAInstallerPolicy" }, { "name": "ROSAKMSProviderPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAKMSProviderPolicy" }, { "name": "ROSAKubeControllerPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAKubeControllerPolicy" }, { "name": "ROSAManageSubscription", "value": "arn:aws:iam::aws:policy/ROSAManageSubscription" }, { "name": "ROSANodePoolManagementPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSANodePoolManagementPolicy" }, { "name": "ROSASRESupportPolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSASRESupportPolicy" }, { "name": "ROSAWorkerInstancePolicy", "value": "arn:aws:iam::aws:policy/service-role/ROSAWorkerInstancePolicy" }, { "name": "ReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ReadOnlyAccess" }, { "name": "ResourceGroupsServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ResourceGroupsServiceRolePolicy" }, { "name": "ResourceGroupsandTagEditorFullAccess", "value": "arn:aws:iam::aws:policy/ResourceGroupsandTagEditorFullAccess" }, { "name": "ResourceGroupsandTagEditorReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ResourceGroupsandTagEditorReadOnlyAccess" }, { "name": "Route53RecoveryReadinessServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/Route53RecoveryReadinessServiceRolePolicy" }, { "name": "Route53ResolverServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/Route53ResolverServiceRolePolicy" }, { "name": "S3StorageLensServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/S3StorageLensServiceRolePolicy" }, { "name": "SecretsManagerReadWrite", "value": "arn:aws:iam::aws:policy/SecretsManagerReadWrite" }, { "name": "SecurityAudit", "value": "arn:aws:iam::aws:policy/SecurityAudit" }, { "name": "SecurityLakeServiceLinkedRole", "value": "arn:aws:iam::aws:policy/aws-service-role/SecurityLakeServiceLinkedRole" }, { "name": "ServerMigrationConnector", "value": "arn:aws:iam::aws:policy/ServerMigrationConnector" }, { "name": "ServerMigrationServiceRole", "value": "arn:aws:iam::aws:policy/service-role/ServerMigrationServiceRole", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AWSServerMigration_ServiceRole instead." }, { "name": "ServiceCatalogAdminFullAccess", "value": "arn:aws:iam::aws:policy/ServiceCatalogAdminFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AWSServiceCatalogAdminFullAccess instead." }, { "name": "ServiceCatalogAdminReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ServiceCatalogAdminReadOnlyAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AWSServiceCatalogAdminReadOnlyAccess instead." }, { "name": "ServiceCatalogEndUserAccess", "value": "arn:aws:iam::aws:policy/ServiceCatalogEndUserAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AWSServiceCatalogEndUserReadOnlyAccess instead." }, { "name": "ServiceCatalogEndUserFullAccess", "value": "arn:aws:iam::aws:policy/ServiceCatalogEndUserFullAccess", "deprecationMessage": "This policy is deprecated and will be removed in a future release. Use AWSServiceCatalogEndUserFullAccess instead." }, { "name": "ServerMigrationServiceConsoleFullAccess", "value": "arn:aws:iam::aws:policy/ServerMigrationServiceConsoleFullAccess" }, { "name": "ServerMigrationServiceLaunchRole", "value": "arn:aws:iam::aws:policy/service-role/ServerMigrationServiceLaunchRole" }, { "name": "ServerMigrationServiceRoleForInstanceValidation", "value": "arn:aws:iam::aws:policy/service-role/ServerMigrationServiceRoleForInstanceValidation" }, { "name": "AWSServerMigration_ServiceRole", "value": "arn:aws:iam::aws:policy/service-role/ServerMigration_ServiceRole" }, { "name": "ServiceQuotasFullAccess", "value": "arn:aws:iam::aws:policy/ServiceQuotasFullAccess" }, { "name": "ServiceQuotasReadOnlyAccess", "value": "arn:aws:iam::aws:policy/ServiceQuotasReadOnlyAccess" }, { "name": "ServiceQuotasServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/ServiceQuotasServiceRolePolicy" }, { "name": "SimpleWorkflowFullAccess", "value": "arn:aws:iam::aws:policy/SimpleWorkflowFullAccess" }, { "name": "SupportUser", "value": "arn:aws:iam::aws:policy/job-function/SupportUser" }, { "name": "SystemAdministrator", "value": "arn:aws:iam::aws:policy/job-function/SystemAdministrator" }, { "name": "TranslateFullAccess", "value": "arn:aws:iam::aws:policy/TranslateFullAccess" }, { "name": "TranslateReadOnly", "value": "arn:aws:iam::aws:policy/TranslateReadOnly" }, { "name": "VMImportExportRoleForAWSConnector", "value": "arn:aws:iam::aws:policy/service-role/VMImportExportRoleForAWSConnector" }, { "name": "VPCLatticeFullAccess", "value": "arn:aws:iam::aws:policy/VPCLatticeFullAccess" }, { "name": "VPCLatticeReadOnlyAccess", "value": "arn:aws:iam::aws:policy/VPCLatticeReadOnlyAccess" }, { "name": "VPCLatticeServicesInvokeAccess", "value": "arn:aws:iam::aws:policy/VPCLatticeServicesInvokeAccess" }, { "name": "ViewOnlyAccess", "value": "arn:aws:iam::aws:policy/job-function/ViewOnlyAccess" }, { "name": "WAFLoggingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/WAFLoggingServiceRolePolicy" }, { "name": "WAFRegionalLoggingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/WAFRegionalLoggingServiceRolePolicy" }, { "name": "WAFV2LoggingServiceRolePolicy", "value": "arn:aws:iam::aws:policy/aws-service-role/WAFV2LoggingServiceRolePolicy" }, { "name": "WellArchitectedConsoleFullAccess", "value": "arn:aws:iam::aws:policy/WellArchitectedConsoleFullAccess" }, { "name": "WellArchitectedConsoleReadOnlyAccess", "value": "arn:aws:iam::aws:policy/WellArchitectedConsoleReadOnlyAccess" }, { "name": "WorkLinkServiceRolePolicy", "value": "arn:aws:iam::aws:policy/WorkLinkServiceRolePolicy" } ] }, "aws:iam/RoleInlinePolicy:RoleInlinePolicy": { "properties": { "name": { "type": "string", "description": "Name of the role policy.\n" }, "policy": { "type": "string", "description": "Policy document as a JSON formatted string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name" ] } } }, "aws:iam/getAccessKeysAccessKey:getAccessKeysAccessKey": { "properties": { "accessKeyId": { "type": "string", "description": "Access key ID.\n" }, "createDate": { "type": "string", "description": "Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the access key was created.\n" }, "status": { "type": "string", "description": "Access key status. Possible values are `Active` and `Inactive`.\n" } }, "type": "object", "required": [ "accessKeyId", "createDate", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:iam/getGroupUser:getGroupUser": { "properties": { "arn": { "type": "string", "description": "User ARN.\n" }, "path": { "type": "string", "description": "Path to the IAM user.\n" }, "userId": { "type": "string", "description": "Stable and unique string identifying the IAM user.\n" }, "userName": { "type": "string", "description": "Name of the IAM user.\n" } }, "type": "object", "required": [ "arn", "path", "userId", "userName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:iam/getPolicyDocumentStatement:getPolicyDocumentStatement": { "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "List of actions that this statement either allows or denies. For example, `[\"ec2:RunInstances\", \"s3:*\"]`.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/aws:iam/getPolicyDocumentStatementCondition:getPolicyDocumentStatementCondition" }, "description": "Configuration block for a condition. Detailed below.\n" }, "effect": { "type": "string", "description": "Whether this statement allows or denies the given actions. Valid values are `Allow` and `Deny`. Defaults to `Allow`.\n" }, "notActions": { "type": "array", "items": { "type": "string" }, "description": "List of actions that this statement does *not* apply to. Use to apply a policy statement to all actions *except* those listed.\n" }, "notPrincipals": { "type": "array", "items": { "$ref": "#/types/aws:iam/getPolicyDocumentStatementNotPrincipal:getPolicyDocumentStatementNotPrincipal" }, "description": "Like `principals` except these are principals that the statement does *not* apply to.\n" }, "notResources": { "type": "array", "items": { "type": "string" }, "description": "List of resource ARNs that this statement does *not* apply to. Use to apply a policy statement to all resources *except* those listed. Conflicts with `resources`.\n" }, "principals": { "type": "array", "items": { "$ref": "#/types/aws:iam/getPolicyDocumentStatementPrincipal:getPolicyDocumentStatementPrincipal" }, "description": "Configuration block for principals. Detailed below.\n" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "List of resource ARNs that this statement applies to. This is required by AWS if used for an IAM policy. Conflicts with `not_resources`.\n" }, "sid": { "type": "string", "description": "Sid (statement ID) is an identifier for a policy statement.\n" } }, "type": "object" }, "aws:iam/getPolicyDocumentStatementCondition:getPolicyDocumentStatementCondition": { "properties": { "test": { "type": "string", "description": "Name of the [IAM condition operator](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html) to evaluate.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values to evaluate the condition against. If multiple values are provided, the condition matches if at least one of them applies. That is, AWS evaluates multiple values as though using an \"OR\" boolean operation.\n" }, "variable": { "type": "string", "description": "Name of a [Context Variable](http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#AvailableKeys) to apply the condition to. Context variables may either be standard AWS variables starting with `aws:` or service-specific variables prefixed with the service name.\n" } }, "type": "object", "required": [ "test", "values", "variable" ] }, "aws:iam/getPolicyDocumentStatementNotPrincipal:getPolicyDocumentStatementNotPrincipal": { "properties": { "identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of identifiers for principals. When `type` is `AWS`, these are IAM principal ARNs, e.g., `arn:aws:iam::12345678901:role/yak-role`. When `type` is `Service`, these are AWS Service roles, e.g., `lambda.amazonaws.com`. When `type` is `Federated`, these are web identity users or SAML provider ARNs, e.g., `accounts.google.com` or `arn:aws:iam::12345678901:saml-provider/yak-saml-provider`. When `type` is `CanonicalUser`, these are [canonical user IDs](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId), e.g., `79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be`.\n" }, "type": { "type": "string", "description": "Type of principal. Valid values include `AWS`, `Service`, `Federated`, `CanonicalUser` and `*`.\n" } }, "type": "object", "required": [ "identifiers", "type" ] }, "aws:iam/getPolicyDocumentStatementPrincipal:getPolicyDocumentStatementPrincipal": { "properties": { "identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of identifiers for principals. When `type` is `AWS`, these are IAM principal ARNs, e.g., `arn:aws:iam::12345678901:role/yak-role`. When `type` is `Service`, these are AWS Service roles, e.g., `lambda.amazonaws.com`. When `type` is `Federated`, these are web identity users or SAML provider ARNs, e.g., `accounts.google.com` or `arn:aws:iam::12345678901:saml-provider/yak-saml-provider`. When `type` is `CanonicalUser`, these are [canonical user IDs](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId), e.g., `79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be`.\n" }, "type": { "type": "string", "description": "Type of principal. Valid values include `AWS`, `Service`, `Federated`, `CanonicalUser` and `*`.\n" } }, "type": "object", "required": [ "identifiers", "type" ] }, "aws:iam/getPrincipalPolicySimulationContext:getPrincipalPolicySimulationContext": { "properties": { "key": { "type": "string", "description": "The context _condition key_ to set.\n\nIf you have policies containing `Condition` elements or using dynamic interpolations then you will need to provide suitable values for each condition key your policies use. See [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) to find the various condition keys that are normally provided for real requests to each action of each AWS service.\n" }, "type": { "type": "string", "description": "An IAM value type that determines how the policy simulator will interpret the strings given in `values`.\n\nFor more information, see the `ContextKeyType` field of [`iam.ContextEntry`](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextEntry.html) in the underlying API.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A set of one or more values for this context entry.\n" } }, "type": "object", "required": [ "key", "type", "values" ] }, "aws:iam/getPrincipalPolicySimulationResult:getPrincipalPolicySimulationResult": { "properties": { "actionName": { "type": "string", "description": "The name of the single IAM action used for this particular request.\n" }, "allowed": { "type": "boolean", "description": "`true` if `decision` is \"allowed\", and `false` otherwise.\n" }, "decision": { "type": "string", "description": "The raw decision determined from all of the policies in scope; either \"allowed\", \"explicitDeny\", or \"implicitDeny\".\n" }, "decisionDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of arbitrary metadata entries returned by the policy simulator for this request.\n" }, "matchedStatements": { "type": "array", "items": { "$ref": "#/types/aws:iam/getPrincipalPolicySimulationResultMatchedStatement:getPrincipalPolicySimulationResultMatchedStatement" }, "description": "A nested set of objects describing which policies contained statements that were relevant to this simulation request. Each object has attributes `source_policy_id` and `source_policy_type` to identify one of the policies.\n" }, "missingContextKeys": { "type": "array", "items": { "type": "string" }, "description": "A set of context keys (or condition keys) that were needed by some of the policies contributing to this result but not specified using a `context` block in the configuration. Missing or incorrect context keys will typically cause a simulated request to be disallowed.\n" }, "resourceArn": { "type": "string", "description": "ARN of the resource that was used for this particular request. When you specify multiple actions and multiple resource ARNs, that causes a separate policy request for each combination of unique action and resource.\n" } }, "type": "object", "required": [ "actionName", "allowed", "decision", "decisionDetails", "matchedStatements", "missingContextKeys", "resourceArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:iam/getPrincipalPolicySimulationResultMatchedStatement:getPrincipalPolicySimulationResultMatchedStatement": { "properties": { "sourcePolicyId": { "type": "string", "description": "Identifier of one of the policies used as input to the simulation.\n" }, "sourcePolicyType": { "type": "string", "description": "The type of the policy identified in source_policy_id.\n" } }, "type": "object", "required": [ "sourcePolicyId", "sourcePolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:iam/getRoleRoleLastUsed:getRoleRoleLastUsed": { "properties": { "lastUsedDate": { "type": "string", "description": "The date and time, in RFC 3339 format, that the role was last used.\n" }, "region": { "type": "string", "description": "The name of the AWS Region in which the role was last used.\n" } }, "type": "object", "required": [ "lastUsedDate", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/GroupExternalId:GroupExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "issuer" ] } } }, "aws:identitystore/UserAddresses:UserAddresses": { "properties": { "country": { "type": "string", "description": "The country that this address is in.\n" }, "formatted": { "type": "string", "description": "The name that is typically displayed when the address is shown for display.\n" }, "locality": { "type": "string", "description": "The address locality.\n" }, "postalCode": { "type": "string", "description": "The postal code of the address.\n" }, "primary": { "type": "boolean", "description": "When `true`, this is the primary address associated with the user.\n" }, "region": { "type": "string", "description": "The region of the address.\n" }, "streetAddress": { "type": "string", "description": "The street of the address.\n" }, "type": { "type": "string", "description": "The type of address.\n" } }, "type": "object" }, "aws:identitystore/UserEmails:UserEmails": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary email associated with the user.\n" }, "type": { "type": "string", "description": "The type of email.\n" }, "value": { "type": "string", "description": "The email address. This value must be unique across the identity store.\n" } }, "type": "object" }, "aws:identitystore/UserExternalId:UserExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "issuer" ] } } }, "aws:identitystore/UserName:UserName": { "properties": { "familyName": { "type": "string", "description": "The family name of the user.\n" }, "formatted": { "type": "string", "description": "The name that is typically displayed when the name is shown for display.\n" }, "givenName": { "type": "string", "description": "The given name of the user.\n\nThe following arguments are optional:\n" }, "honorificPrefix": { "type": "string", "description": "The honorific prefix of the user.\n" }, "honorificSuffix": { "type": "string", "description": "The honorific suffix of the user.\n" }, "middleName": { "type": "string", "description": "The middle name of the user.\n" } }, "type": "object", "required": [ "familyName", "givenName" ] }, "aws:identitystore/UserPhoneNumbers:UserPhoneNumbers": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "type": { "type": "string", "description": "The type of phone number.\n" }, "value": { "type": "string", "description": "The user's phone number.\n" } }, "type": "object" }, "aws:identitystore/getGroupAlternateIdentifier:getGroupAlternateIdentifier": { "properties": { "externalId": { "$ref": "#/types/aws:identitystore/getGroupAlternateIdentifierExternalId:getGroupAlternateIdentifierExternalId", "description": "Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.\n" }, "uniqueAttribute": { "$ref": "#/types/aws:identitystore/getGroupAlternateIdentifierUniqueAttribute:getGroupAlternateIdentifierUniqueAttribute", "description": "An entity attribute that's unique to a specific entity. Detailed below.\n\n\u003e Exactly one of the above arguments must be provided.\n" } }, "type": "object" }, "aws:identitystore/getGroupAlternateIdentifierExternalId:getGroupAlternateIdentifierExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ] }, "aws:identitystore/getGroupAlternateIdentifierUniqueAttribute:getGroupAlternateIdentifierUniqueAttribute": { "properties": { "attributePath": { "type": "string", "description": "Attribute path that is used to specify which attribute name to search. For example: `DisplayName`. Refer to the [Group data type](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html).\n" }, "attributeValue": { "type": "string", "description": "Value for an attribute.\n" } }, "type": "object", "required": [ "attributePath", "attributeValue" ] }, "aws:identitystore/getGroupExternalId:getGroupExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getGroupFilter:getGroupFilter": { "properties": { "attributePath": { "type": "string", "description": "Attribute path that is used to specify which attribute name to search. Currently, `DisplayName` is the only valid attribute path.\n" }, "attributeValue": { "type": "string", "description": "Value for an attribute.\n" } }, "type": "object", "required": [ "attributePath", "attributeValue" ] }, "aws:identitystore/getGroupMembershipsGroupMembership:getGroupMembershipsGroupMembership": { "properties": { "groupId": { "type": "string", "description": "The identifier for a group in the Identity Store.\n" }, "identityStoreId": { "type": "string", "description": "Identity Store ID associated with the Single Sign-On Instance.\n" }, "memberId": { "$ref": "#/types/aws:identitystore/getGroupMembershipsGroupMembershipMemberId:getGroupMembershipsGroupMembershipMemberId", "description": "An object containing the identifier of a group member. See `member_id` below.\n" }, "membershipId": { "type": "string" } }, "type": "object", "required": [ "groupId", "identityStoreId", "memberId", "membershipId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getGroupMembershipsGroupMembershipMemberId:getGroupMembershipsGroupMembershipMemberId": { "properties": { "userId": { "type": "string", "description": "User identifier of the group member.\n" } }, "type": "object", "required": [ "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getGroupsGroup:getGroupsGroup": { "properties": { "description": { "type": "string", "description": "Description of the specified group.\n" }, "displayName": { "type": "string", "description": "Group's display name.\n" }, "externalIds": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getGroupsGroupExternalId:getGroupsGroupExternalId" }, "description": "List of identifiers issued to this resource by an external identity provider.\n" }, "groupId": { "type": "string", "description": "Identifier of the group in the Identity Store.\n" }, "identityStoreId": { "type": "string", "description": "Identity Store ID associated with the Single Sign-On (SSO) Instance.\n" } }, "type": "object", "required": [ "description", "displayName", "externalIds", "groupId", "identityStoreId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getGroupsGroupExternalId:getGroupsGroupExternalId": { "properties": { "id": { "type": "string", "description": "Identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "Issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUserAddress:getUserAddress": { "properties": { "country": { "type": "string", "description": "The country that this address is in.\n" }, "formatted": { "type": "string", "description": "The name that is typically displayed when the name is shown for display.\n" }, "locality": { "type": "string", "description": "The address locality.\n" }, "postalCode": { "type": "string", "description": "The postal code of the address.\n" }, "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "region": { "type": "string", "description": "The region of the address.\n" }, "streetAddress": { "type": "string", "description": "The street of the address.\n" }, "type": { "type": "string", "description": "The type of phone number.\n" } }, "type": "object", "required": [ "country", "formatted", "locality", "postalCode", "primary", "region", "streetAddress", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUserAlternateIdentifier:getUserAlternateIdentifier": { "properties": { "externalId": { "$ref": "#/types/aws:identitystore/getUserAlternateIdentifierExternalId:getUserAlternateIdentifierExternalId", "description": "Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.\n" }, "uniqueAttribute": { "$ref": "#/types/aws:identitystore/getUserAlternateIdentifierUniqueAttribute:getUserAlternateIdentifierUniqueAttribute", "description": "An entity attribute that's unique to a specific entity. Detailed below.\n\n\u003e Exactly one of the above arguments must be provided.\n" } }, "type": "object" }, "aws:identitystore/getUserAlternateIdentifierExternalId:getUserAlternateIdentifierExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ] }, "aws:identitystore/getUserAlternateIdentifierUniqueAttribute:getUserAlternateIdentifierUniqueAttribute": { "properties": { "attributePath": { "type": "string", "description": "Attribute path that is used to specify which attribute name to search. For example: `UserName`. Refer to the [User data type](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html).\n" }, "attributeValue": { "type": "string", "description": "Value for an attribute.\n" } }, "type": "object", "required": [ "attributePath", "attributeValue" ] }, "aws:identitystore/getUserEmail:getUserEmail": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "type": { "type": "string", "description": "The type of phone number.\n" }, "value": { "type": "string", "description": "The user's phone number.\n" } }, "type": "object", "required": [ "primary", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUserExternalId:getUserExternalId": { "properties": { "id": { "type": "string", "description": "The identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "The issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUserFilter:getUserFilter": { "properties": { "attributePath": { "type": "string", "description": "Attribute path that is used to specify which attribute name to search. Currently, `UserName` is the only valid attribute path.\n" }, "attributeValue": { "type": "string", "description": "Value for an attribute.\n" } }, "type": "object", "required": [ "attributePath", "attributeValue" ] }, "aws:identitystore/getUserName:getUserName": { "properties": { "familyName": { "type": "string", "description": "The family name of the user.\n" }, "formatted": { "type": "string", "description": "The name that is typically displayed when the name is shown for display.\n" }, "givenName": { "type": "string", "description": "The given name of the user.\n" }, "honorificPrefix": { "type": "string", "description": "The honorific prefix of the user.\n" }, "honorificSuffix": { "type": "string", "description": "The honorific suffix of the user.\n" }, "middleName": { "type": "string", "description": "The middle name of the user.\n" } }, "type": "object", "required": [ "familyName", "formatted", "givenName", "honorificPrefix", "honorificSuffix", "middleName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUserPhoneNumber:getUserPhoneNumber": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "type": { "type": "string", "description": "The type of phone number.\n" }, "value": { "type": "string", "description": "The user's phone number.\n" } }, "type": "object", "required": [ "primary", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUser:getUsersUser": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getUsersUserAddress:getUsersUserAddress" }, "description": "List of details about the user's address.\n" }, "displayName": { "type": "string", "description": "Name that is typically displayed when the user is referenced.\n" }, "emails": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getUsersUserEmail:getUsersUserEmail" }, "description": "List of details about the user's email.\n" }, "externalIds": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getUsersUserExternalId:getUsersUserExternalId" }, "description": "List of identifiers issued to this resource by an external identity provider.\n" }, "identityStoreId": { "type": "string", "description": "Identity Store ID associated with the Single Sign-On Instance.\n" }, "locale": { "type": "string", "description": "User's geographical region or location.\n" }, "names": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getUsersUserName:getUsersUserName" }, "description": "Details about the user's full name.\n" }, "nickname": { "type": "string", "description": "An alternate name for the user.\n" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/types/aws:identitystore/getUsersUserPhoneNumber:getUsersUserPhoneNumber" }, "description": "List of details about the user's phone number.\n" }, "preferredLanguage": { "type": "string", "description": "Preferred language of the user.\n" }, "profileUrl": { "type": "string", "description": "An URL that may be associated with the user.\n" }, "timezone": { "type": "string", "description": "User's time zone.\n" }, "title": { "type": "string", "description": "User's title.\n" }, "userId": { "type": "string", "description": "Identifier of the user in the Identity Store.\n" }, "userName": { "type": "string", "description": "User's user name value.\n" }, "userType": { "type": "string", "description": "User type.\n" } }, "type": "object", "required": [ "addresses", "displayName", "emails", "externalIds", "identityStoreId", "locale", "names", "nickname", "phoneNumbers", "preferredLanguage", "profileUrl", "timezone", "title", "userId", "userName", "userType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUserAddress:getUsersUserAddress": { "properties": { "country": { "type": "string", "description": "Country that this address is in.\n" }, "formatted": { "type": "string", "description": "Name that is typically displayed when the name is shown for display.\n" }, "locality": { "type": "string", "description": "Address locality.\n" }, "postalCode": { "type": "string", "description": "Postal code of the address.\n" }, "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "region": { "type": "string", "description": "Region of the address.\n" }, "streetAddress": { "type": "string", "description": "Street of the address.\n" }, "type": { "type": "string", "description": "Type of phone number.\n" } }, "type": "object", "required": [ "country", "formatted", "locality", "postalCode", "primary", "region", "streetAddress", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUserEmail:getUsersUserEmail": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "type": { "type": "string", "description": "Type of phone number.\n" }, "value": { "type": "string", "description": "User's phone number.\n" } }, "type": "object", "required": [ "primary", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUserExternalId:getUsersUserExternalId": { "properties": { "id": { "type": "string", "description": "Identifier issued to this resource by an external identity provider.\n" }, "issuer": { "type": "string", "description": "Issuer for an external identifier.\n" } }, "type": "object", "required": [ "id", "issuer" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUserName:getUsersUserName": { "properties": { "familyName": { "type": "string", "description": "Family name of the user.\n" }, "formatted": { "type": "string", "description": "Name that is typically displayed when the name is shown for display.\n" }, "givenName": { "type": "string", "description": "Given name of the user.\n" }, "honorificPrefix": { "type": "string", "description": "Honorific prefix of the user.\n" }, "honorificSuffix": { "type": "string", "description": "Honorific suffix of the user.\n" }, "middleName": { "type": "string", "description": "Middle name of the user.\n" } }, "type": "object", "required": [ "familyName", "formatted", "givenName", "honorificPrefix", "honorificSuffix", "middleName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:identitystore/getUsersUserPhoneNumber:getUsersUserPhoneNumber": { "properties": { "primary": { "type": "boolean", "description": "When `true`, this is the primary phone number associated with the user.\n" }, "type": { "type": "string", "description": "Type of phone number.\n" }, "value": { "type": "string", "description": "User's phone number.\n" } }, "type": "object", "required": [ "primary", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/ContainerRecipeComponent:ContainerRecipeComponent": { "properties": { "componentArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the Image Builder Component to associate.\n", "willReplaceOnChanges": true }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ContainerRecipeComponentParameter:ContainerRecipeComponentParameter" }, "description": "Configuration block(s) for parameters to configure the component. Detailed below.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "componentArn" ] }, "aws:imagebuilder/ContainerRecipeComponentParameter:ContainerRecipeComponentParameter": { "properties": { "name": { "type": "string", "description": "The name of the component parameter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value for the named component parameter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "value" ] }, "aws:imagebuilder/ContainerRecipeInstanceConfiguration:ContainerRecipeInstanceConfiguration": { "properties": { "blockDeviceMappings": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ContainerRecipeInstanceConfigurationBlockDeviceMapping:ContainerRecipeInstanceConfigurationBlockDeviceMapping" }, "description": "Configuration block(s) with block device mappings for the container recipe. Detailed below.\n", "willReplaceOnChanges": true }, "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.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:imagebuilder/ContainerRecipeInstanceConfigurationBlockDeviceMapping:ContainerRecipeInstanceConfigurationBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "Name of the device. For example, `/dev/sda` or `/dev/xvdb`.\n", "willReplaceOnChanges": true }, "ebs": { "$ref": "#/types/aws:imagebuilder/ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs:ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs", "description": "Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.\n", "willReplaceOnChanges": true }, "noDevice": { "type": "boolean", "description": "Set to `true` to remove a mapping from the parent image.\n", "willReplaceOnChanges": true }, "virtualName": { "type": "string", "description": "Virtual device name. For example, `ephemeral0`. Instance store volumes are numbered starting from 0.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "noDevice" ] } } }, "aws:imagebuilder/ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs:ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs": { "properties": { "deleteOnTermination": { "type": "string", "description": "Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.\n", "willReplaceOnChanges": true }, "encrypted": { "type": "string", "description": "Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.\n", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "description": "Identifier of the EC2 Volume Snapshot.\n", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "description": "For GP3 volumes only. The throughput in MiB/s that the volume supports.\n", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "Type of the volume. For example, `gp2` or `io2`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:imagebuilder/ContainerRecipeTargetRepository:ContainerRecipeTargetRepository": { "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.\n", "willReplaceOnChanges": true }, "service": { "type": "string", "description": "The service in which this image is registered. Valid values: `ECR`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "repositoryName", "service" ] }, "aws:imagebuilder/DistributionConfigurationDistribution:DistributionConfigurationDistribution": { "properties": { "amiDistributionConfiguration": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionAmiDistributionConfiguration:DistributionConfigurationDistributionAmiDistributionConfiguration", "description": "Configuration block with Amazon Machine Image (AMI) distribution settings. Detailed below.\n" }, "containerDistributionConfiguration": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionContainerDistributionConfiguration:DistributionConfigurationDistributionContainerDistributionConfiguration", "description": "Configuration block with container distribution settings. Detailed below.\n" }, "fastLaunchConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfiguration:DistributionConfigurationDistributionFastLaunchConfiguration" }, "description": "Set of Windows faster-launching configurations to use for AMI distribution. Detailed below.\n" }, "launchTemplateConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionLaunchTemplateConfiguration:DistributionConfigurationDistributionLaunchTemplateConfiguration" }, "description": "Set of launch template configuration settings that apply to image distribution. Detailed below.\n" }, "licenseConfigurationArns": { "type": "array", "items": { "type": "string" }, "description": "Set of Amazon Resource Names (ARNs) of License Manager License Configurations.\n" }, "region": { "type": "string", "description": "AWS Region for the distribution.\n\nThe following arguments are optional:\n" }, "s3ExportConfiguration": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionS3ExportConfiguration:DistributionConfigurationDistributionS3ExportConfiguration", "description": "Configuration block with S3 export settings. Detailed below.\n" } }, "type": "object", "required": [ "region" ] }, "aws:imagebuilder/DistributionConfigurationDistributionAmiDistributionConfiguration:DistributionConfigurationDistributionAmiDistributionConfiguration": { "properties": { "amiTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value map of tags to apply to the distributed AMI.\n" }, "description": { "type": "string", "description": "Description to apply to the distributed AMI.\n" }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the Key Management Service (KMS) Key to encrypt the distributed AMI.\n" }, "launchPermission": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission:DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission", "description": "Configuration block of EC2 launch permissions to apply to the distributed AMI. Detailed below.\n" }, "name": { "type": "string", "description": "Name to apply to the distributed AMI.\n" }, "targetAccountIds": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Account identifiers to distribute the AMI.\n" } }, "type": "object" }, "aws:imagebuilder/DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission:DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission": { "properties": { "organizationArns": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Organization ARNs to assign.\n" }, "organizationalUnitArns": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Organizational Unit ARNs to assign.\n" }, "userGroups": { "type": "array", "items": { "type": "string" }, "description": "Set of EC2 launch permission user groups to assign. Use `all` to distribute a public AMI.\n" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Account identifiers to assign.\n" } }, "type": "object" }, "aws:imagebuilder/DistributionConfigurationDistributionContainerDistributionConfiguration:DistributionConfigurationDistributionContainerDistributionConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" }, "description": "Set of tags that are attached to the container distribution configuration.\n" }, "description": { "type": "string", "description": "Description of the container distribution configuration.\n" }, "targetRepository": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository:DistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository", "description": "Configuration block with the destination repository for the container distribution configuration.\n" } }, "type": "object", "required": [ "targetRepository" ] }, "aws:imagebuilder/DistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository:DistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository": { "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.\n" }, "service": { "type": "string", "description": "The service in which this image is registered. Valid values: `ECR`.\n" } }, "type": "object", "required": [ "repositoryName", "service" ] }, "aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfiguration:DistributionConfigurationDistributionFastLaunchConfiguration": { "properties": { "accountId": { "type": "string", "description": "The owner account ID for the fast-launch enabled Windows AMI.\n" }, "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.\n" }, "launchTemplate": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate:DistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate", "description": "Configuration block for the launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots. Detailed below.\n" }, "maxParallelLaunches": { "type": "integer", "description": "The maximum number of parallel instances that are launched for creating resources.\n" }, "snapshotConfiguration": { "$ref": "#/types/aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration:DistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration", "description": "Configuration block for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled. Detailed below.\n" } }, "type": "object", "required": [ "accountId", "enabled" ] }, "aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate:DistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate": { "properties": { "launchTemplateId": { "type": "string", "description": "The ID of the launch template to use for faster launching for a Windows AMI.\n" }, "launchTemplateName": { "type": "string", "description": "The name of the launch template to use for faster launching for a Windows AMI.\n" }, "launchTemplateVersion": { "type": "string", "description": "The version of the launch template to use for faster launching for a Windows AMI.\n" } }, "type": "object" }, "aws:imagebuilder/DistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration:DistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration": { "properties": { "targetResourceCount": { "type": "integer", "description": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.\n" } }, "type": "object" }, "aws:imagebuilder/DistributionConfigurationDistributionLaunchTemplateConfiguration:DistributionConfigurationDistributionLaunchTemplateConfiguration": { "properties": { "accountId": { "type": "string", "description": "The account ID that this configuration applies to.\n" }, "default": { "type": "boolean", "description": "Indicates whether to set the specified Amazon EC2 launch template as the default launch template. Defaults to `true`.\n" }, "launchTemplateId": { "type": "string", "description": "The ID of the Amazon EC2 launch template to use.\n" } }, "type": "object", "required": [ "launchTemplateId" ] }, "aws:imagebuilder/DistributionConfigurationDistributionS3ExportConfiguration:DistributionConfigurationDistributionS3ExportConfiguration": { "properties": { "diskImageFormat": { "type": "string", "description": "The disk image format of the exported image (`RAW`, `VHD`, or `VMDK`)\n" }, "roleName": { "type": "string", "description": "The name of the IAM role to use for exporting.\n" }, "s3Bucket": { "type": "string", "description": "The name of the S3 bucket to store the exported image in. The bucket needs to exist before the export configuration is created.\n" }, "s3Prefix": { "type": "string", "description": "The prefix for the exported image.\n" } }, "type": "object", "required": [ "diskImageFormat", "roleName", "s3Bucket" ] }, "aws:imagebuilder/ImageImageScanningConfiguration:ImageImageScanningConfiguration": { "properties": { "ecrConfiguration": { "$ref": "#/types/aws:imagebuilder/ImageImageScanningConfigurationEcrConfiguration:ImageImageScanningConfigurationEcrConfiguration", "description": "Configuration block with ECR configuration. Detailed below.\n" }, "imageScanningEnabled": { "type": "boolean", "description": "Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. Defaults to `false`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecrConfiguration" ] } } }, "aws:imagebuilder/ImageImageScanningConfigurationEcrConfiguration:ImageImageScanningConfigurationEcrConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" }, "description": "Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.\n" }, "repositoryName": { "type": "string", "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images.\n" } }, "type": "object" }, "aws:imagebuilder/ImageImageTestsConfiguration:ImageImageTestsConfiguration": { "properties": { "imageTestsEnabled": { "type": "boolean", "description": "Whether image tests are enabled. Defaults to `true`.\n", "willReplaceOnChanges": true }, "timeoutMinutes": { "type": "integer", "description": "Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:imagebuilder/ImageOutputResource:ImageOutputResource": { "properties": { "amis": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ImageOutputResourceAmi:ImageOutputResourceAmi" }, "description": "Set of objects with each Amazon Machine Image (AMI) created.\n" }, "containers": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ImageOutputResourceContainer:ImageOutputResourceContainer" }, "description": "Set of objects with each container image created and stored in the output repository.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amis", "containers" ] } } }, "aws:imagebuilder/ImageOutputResourceAmi:ImageOutputResourceAmi": { "properties": { "accountId": { "type": "string", "description": "Account identifier of the AMI.\n" }, "description": { "type": "string", "description": "Description of the AMI.\n" }, "image": { "type": "string", "description": "Identifier of the AMI.\n" }, "name": { "type": "string", "description": "Name of the AMI.\n" }, "region": { "type": "string", "description": "Region of the container image.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "description", "image", "name", "region" ] } } }, "aws:imagebuilder/ImageOutputResourceContainer:ImageOutputResourceContainer": { "properties": { "imageUris": { "type": "array", "items": { "type": "string" }, "description": "Set of URIs for created containers.\n" }, "region": { "type": "string", "description": "Region of the container image.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "imageUris", "region" ] } } }, "aws:imagebuilder/ImagePipelineImageScanningConfiguration:ImagePipelineImageScanningConfiguration": { "properties": { "ecrConfiguration": { "$ref": "#/types/aws:imagebuilder/ImagePipelineImageScanningConfigurationEcrConfiguration:ImagePipelineImageScanningConfigurationEcrConfiguration", "description": "Configuration block with ECR configuration for image scanning. Detailed below.\n" }, "imageScanningEnabled": { "type": "boolean", "description": "Whether image scans are enabled. Defaults to `false`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecrConfiguration" ] } } }, "aws:imagebuilder/ImagePipelineImageScanningConfigurationEcrConfiguration:ImagePipelineImageScanningConfigurationEcrConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" } }, "repositoryName": { "type": "string", "description": "The name of the repository to scan\n" } }, "type": "object" }, "aws:imagebuilder/ImagePipelineImageTestsConfiguration:ImagePipelineImageTestsConfiguration": { "properties": { "imageTestsEnabled": { "type": "boolean", "description": "Whether image tests are enabled. Defaults to `true`.\n" }, "timeoutMinutes": { "type": "integer", "description": "Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`.\n" } }, "type": "object" }, "aws:imagebuilder/ImagePipelineSchedule:ImagePipelineSchedule": { "properties": { "pipelineExecutionStartCondition": { "type": "string", "description": "Condition when the pipeline should trigger a new image build. Valid values are `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE` and `EXPRESSION_MATCH_ONLY`. Defaults to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`.\n" }, "scheduleExpression": { "type": "string", "description": "Cron expression of how often the pipeline start condition is evaluated. For example, `cron(0 0 * * ? *)` is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as `cron(0 0 * * *)`, must be updated to the six field syntax. For more information, see the [Image Builder User Guide](https://docs.aws.amazon.com/imagebuilder/latest/userguide/cron-expressions.html).\n\nThe following arguments are optional:\n" }, "timezone": { "type": "string", "description": "The timezone that applies to the scheduling expression. For example, \"Etc/UTC\", \"America/Los_Angeles\" in the [IANA timezone format](https://www.joda.org/joda-time/timezones.html). If not specified this defaults to UTC.\n" } }, "type": "object", "required": [ "scheduleExpression" ], "language": { "nodejs": { "requiredOutputs": [ "scheduleExpression", "timezone" ] } } }, "aws:imagebuilder/ImagePipelineWorkflow:ImagePipelineWorkflow": { "properties": { "onFailure": { "type": "string", "description": "The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`.\n" }, "parallelGroup": { "type": "string", "description": "The parallel group in which to run a test Workflow.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ImagePipelineWorkflowParameter:ImagePipelineWorkflowParameter" }, "description": "Configuration block for the workflow parameters. Detailed below.\n" }, "workflowArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the Image Builder Workflow.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "workflowArn" ] }, "aws:imagebuilder/ImagePipelineWorkflowParameter:ImagePipelineWorkflowParameter": { "properties": { "name": { "type": "string", "description": "The name of the Workflow parameter.\n" }, "value": { "type": "string", "description": "The value of the Workflow parameter.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:imagebuilder/ImageRecipeBlockDeviceMapping:ImageRecipeBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "Name of the device. For example, `/dev/sda` or `/dev/xvdb`.\n", "willReplaceOnChanges": true }, "ebs": { "$ref": "#/types/aws:imagebuilder/ImageRecipeBlockDeviceMappingEbs:ImageRecipeBlockDeviceMappingEbs", "description": "Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.\n", "willReplaceOnChanges": true }, "noDevice": { "type": "boolean", "description": "Set to `true` to remove a mapping from the parent image.\n", "willReplaceOnChanges": true }, "virtualName": { "type": "string", "description": "Virtual device name. For example, `ephemeral0`. Instance store volumes are numbered starting from 0.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "noDevice" ] } } }, "aws:imagebuilder/ImageRecipeBlockDeviceMappingEbs:ImageRecipeBlockDeviceMappingEbs": { "properties": { "deleteOnTermination": { "type": "string", "description": "Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.\n", "willReplaceOnChanges": true }, "encrypted": { "type": "string", "description": "Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.\n", "willReplaceOnChanges": true }, "iops": { "type": "integer", "description": "Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.\n", "willReplaceOnChanges": true }, "snapshotId": { "type": "string", "description": "Identifier of the EC2 Volume Snapshot.\n", "willReplaceOnChanges": true }, "throughput": { "type": "integer", "description": "For GP3 volumes only. The throughput in MiB/s that the volume supports.\n", "willReplaceOnChanges": true }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "Type of the volume. For example, `gp2` or `io2`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:imagebuilder/ImageRecipeComponent:ImageRecipeComponent": { "properties": { "componentArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the Image Builder Component to associate.\n", "willReplaceOnChanges": true }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ImageRecipeComponentParameter:ImageRecipeComponentParameter" }, "description": "Configuration block(s) for parameters to configure the component. Detailed below.\n" } }, "type": "object", "required": [ "componentArn" ] }, "aws:imagebuilder/ImageRecipeComponentParameter:ImageRecipeComponentParameter": { "properties": { "name": { "type": "string", "description": "The name of the component parameter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value for the named component parameter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "value" ] }, "aws:imagebuilder/ImageRecipeSystemsManagerAgent:ImageRecipeSystemsManagerAgent": { "properties": { "uninstallAfterBuild": { "type": "boolean", "description": "Whether to remove the Systems Manager Agent after the image has been built.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "uninstallAfterBuild" ] }, "aws:imagebuilder/ImageWorkflow:ImageWorkflow": { "properties": { "onFailure": { "type": "string", "description": "The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`.\n", "willReplaceOnChanges": true }, "parallelGroup": { "type": "string", "description": "The parallel group in which to run a test Workflow.\n", "willReplaceOnChanges": true }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/ImageWorkflowParameter:ImageWorkflowParameter" }, "description": "Configuration block for the workflow parameters. Detailed below.\n", "willReplaceOnChanges": true }, "workflowArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the Image Builder Workflow.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "workflowArn" ] }, "aws:imagebuilder/ImageWorkflowParameter:ImageWorkflowParameter": { "properties": { "name": { "type": "string", "description": "The name of the Workflow parameter.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value of the Workflow parameter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "value" ] }, "aws:imagebuilder/InfrastructureConfigurationInstanceMetadataOptions:InfrastructureConfigurationInstanceMetadataOptions": { "properties": { "httpPutResponseHopLimit": { "type": "integer", "description": "The number of hops that an instance can traverse to reach its destonation.\n" }, "httpTokens": { "type": "string", "description": "Whether a signed token is required for instance metadata retrieval requests. Valid values: `required`, `optional`.\n" } }, "type": "object" }, "aws:imagebuilder/InfrastructureConfigurationLogging:InfrastructureConfigurationLogging": { "properties": { "s3Logs": { "$ref": "#/types/aws:imagebuilder/InfrastructureConfigurationLoggingS3Logs:InfrastructureConfigurationLoggingS3Logs", "description": "Configuration block with S3 logging settings. Detailed below.\n" } }, "type": "object", "required": [ "s3Logs" ] }, "aws:imagebuilder/InfrastructureConfigurationLoggingS3Logs:InfrastructureConfigurationLoggingS3Logs": { "properties": { "s3BucketName": { "type": "string", "description": "Name of the S3 Bucket.\n\nThe following arguments are optional:\n" }, "s3KeyPrefix": { "type": "string", "description": "Prefix to use for S3 logs. Defaults to `/`.\n" } }, "type": "object", "required": [ "s3BucketName" ] }, "aws:imagebuilder/LifecyclePolicyPolicyDetail:LifecyclePolicyPolicyDetail": { "properties": { "action": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailAction:LifecyclePolicyPolicyDetailAction", "description": "Configuration details for the policy action.\n" }, "exclusionRules": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRules:LifecyclePolicyPolicyDetailExclusionRules", "description": "Additional rules to specify resources that should be exempt from policy actions.\n" }, "filter": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailFilter:LifecyclePolicyPolicyDetailFilter", "description": "Specifies the resources that the lifecycle policy applies to.\n\nThe following arguments are optional:\n" } }, "type": "object" }, "aws:imagebuilder/LifecyclePolicyPolicyDetailAction:LifecyclePolicyPolicyDetailAction": { "properties": { "includeResources": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailActionIncludeResources:LifecyclePolicyPolicyDetailActionIncludeResources", "description": "Specifies the resources that the lifecycle policy applies to. Detailed below.\n" }, "type": { "type": "string", "description": "Specifies the lifecycle action to take. Valid values: `DELETE`, `DEPRECATE` or `DISABLE`.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "type" ] }, "aws:imagebuilder/LifecyclePolicyPolicyDetailActionIncludeResources:LifecyclePolicyPolicyDetailActionIncludeResources": { "properties": { "amis": { "type": "boolean", "description": "Specifies whether the lifecycle action should apply to distributed AMIs.\n" }, "containers": { "type": "boolean", "description": "Specifies whether the lifecycle action should apply to distributed containers.\n" }, "snapshots": { "type": "boolean", "description": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amis", "containers", "snapshots" ] } } }, "aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRules:LifecyclePolicyPolicyDetailExclusionRules": { "properties": { "amis": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRulesAmis:LifecyclePolicyPolicyDetailExclusionRulesAmis", "description": "Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. Detailed below.\n" }, "tagMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.\n" } }, "type": "object" }, "aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRulesAmis:LifecyclePolicyPolicyDetailExclusionRulesAmis": { "properties": { "isPublic": { "type": "boolean", "description": "Configures whether public AMIs are excluded from the lifecycle action.\n" }, "lastLaunched": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRulesAmisLastLaunched:LifecyclePolicyPolicyDetailExclusionRulesAmisLastLaunched", "description": "Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. Detailed below.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Configures AWS Regions that are excluded from the lifecycle action.\n" }, "sharedAccounts": { "type": "array", "items": { "type": "string" }, "description": "Specifies AWS accounts whose resources are excluded from the lifecycle action.\n" }, "tagMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Lists tags that should be excluded from lifecycle actions for the AMIs that have them.\n" } }, "type": "object" }, "aws:imagebuilder/LifecyclePolicyPolicyDetailExclusionRulesAmisLastLaunched:LifecyclePolicyPolicyDetailExclusionRulesAmisLastLaunched": { "properties": { "unit": { "type": "string", "description": "Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years. Valid values: `DAYS`, `WEEKS`, `MONTHS` or `YEARS`.\n" }, "value": { "type": "integer", "description": "The integer number of units for the time period. For example 6 (months).\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:imagebuilder/LifecyclePolicyPolicyDetailFilter:LifecyclePolicyPolicyDetailFilter": { "properties": { "retainAtLeast": { "type": "integer", "description": "For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.\n" }, "type": { "type": "string", "description": "Filter resources based on either age or count. Valid values: `AGE` or `COUNT`.\n" }, "unit": { "type": "string", "description": "Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. Valid values: `DAYS`, `WEEKS`, `MONTHS` or `YEARS`.\n" }, "value": { "type": "integer", "description": "The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "type", "value" ] }, "aws:imagebuilder/LifecyclePolicyResourceSelection:LifecyclePolicyResourceSelection": { "properties": { "recipes": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/LifecyclePolicyResourceSelectionRecipe:LifecyclePolicyResourceSelectionRecipe" }, "description": "A list of recipe that are used as selection criteria for the output images that the lifecycle policy applies to. Detailed below.\n" }, "tagMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.\n" } }, "type": "object" }, "aws:imagebuilder/LifecyclePolicyResourceSelectionRecipe:LifecyclePolicyResourceSelectionRecipe": { "properties": { "name": { "type": "string", "description": "The name of an Image Builder recipe that the lifecycle policy uses for resource selection.\n" }, "semanticVersion": { "type": "string", "description": "The version of the Image Builder recipe specified by the name field.\n" } }, "type": "object", "required": [ "name", "semanticVersion" ] }, "aws:imagebuilder/getComponentsFilter:getComponentsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListComponents API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListComponents.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:imagebuilder/getContainerRecipeComponent:getContainerRecipeComponent": { "properties": { "componentArn": { "type": "string", "description": "ARN of the Image Builder Component.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getContainerRecipeComponentParameter:getContainerRecipeComponentParameter" }, "description": "Set of parameters that are used to configure the component.\n" } }, "type": "object", "required": [ "componentArn", "parameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipeComponentParameter:getContainerRecipeComponentParameter": { "properties": { "name": { "type": "string", "description": "Name of the container recipe.\n" }, "value": { "type": "string", "description": "Value of the component parameter.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipeInstanceConfiguration:getContainerRecipeInstanceConfiguration": { "properties": { "blockDeviceMappings": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getContainerRecipeInstanceConfigurationBlockDeviceMapping:getContainerRecipeInstanceConfigurationBlockDeviceMapping" }, "description": "Set of objects with block device mappings for the instance configuration.\n" }, "image": { "type": "string", "description": "AMI ID of the base image for container build and test instance.\n" } }, "type": "object", "required": [ "blockDeviceMappings", "image" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipeInstanceConfigurationBlockDeviceMapping:getContainerRecipeInstanceConfigurationBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "Name of the device. For example, `/dev/sda` or `/dev/xvdb`.\n" }, "ebs": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getContainerRecipeInstanceConfigurationBlockDeviceMappingEb:getContainerRecipeInstanceConfigurationBlockDeviceMappingEb" }, "description": "Single list of object with Elastic Block Storage (EBS) block device mapping settings.\n" }, "noDevice": { "type": "string", "description": "Whether to remove a mapping from the parent image.\n" }, "virtualName": { "type": "string", "description": "Virtual device name. For example, `ephemeral0`. Instance store volumes are numbered starting from 0.\n" } }, "type": "object", "required": [ "deviceName", "ebs", "noDevice", "virtualName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipeInstanceConfigurationBlockDeviceMappingEb:getContainerRecipeInstanceConfigurationBlockDeviceMappingEb": { "properties": { "deleteOnTermination": { "type": "boolean", "description": "Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.\n" }, "encrypted": { "type": "boolean", "description": "Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.\n" }, "iops": { "type": "integer", "description": "Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume.\n" }, "kmsKeyId": { "type": "string", "description": "KMS key used to encrypt the container image.\n" }, "snapshotId": { "type": "string", "description": "Identifier of the EC2 Volume Snapshot.\n" }, "throughput": { "type": "integer", "description": "For GP3 volumes only. The throughput in MiB/s that the volume supports.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n" }, "volumeType": { "type": "string", "description": "Type of the volume. For example, `gp2` or `io2`.\n" } }, "type": "object", "required": [ "deleteOnTermination", "encrypted", "iops", "kmsKeyId", "snapshotId", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipeTargetRepository:getContainerRecipeTargetRepository": { "properties": { "repositoryName": { "type": "string", "description": "Name of the container repository where the output container image is stored. The name is prefixed by the repository location.\n" }, "service": { "type": "string", "description": "Service in which this image is registered.\n" } }, "type": "object", "required": [ "repositoryName", "service" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getContainerRecipesFilter:getContainerRecipesFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListContainerRecipes API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListContainerRecipes.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:imagebuilder/getDistributionConfigurationDistribution:getDistributionConfigurationDistribution": { "properties": { "amiDistributionConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionAmiDistributionConfiguration:getDistributionConfigurationDistributionAmiDistributionConfiguration" }, "description": "Nested list of AMI distribution configuration.\n" }, "containerDistributionConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionContainerDistributionConfiguration:getDistributionConfigurationDistributionContainerDistributionConfiguration" }, "description": "Nested list of container distribution configurations.\n" }, "fastLaunchConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfiguration:getDistributionConfigurationDistributionFastLaunchConfiguration" }, "description": "Nested list of Windows faster-launching configurations to use for AMI distribution.\n" }, "launchTemplateConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionLaunchTemplateConfiguration:getDistributionConfigurationDistributionLaunchTemplateConfiguration" }, "description": "Nested list of launch template configurations.\n" }, "licenseConfigurationArns": { "type": "array", "items": { "type": "string" }, "description": "Set of Amazon Resource Names (ARNs) of License Manager License Configurations.\n" }, "region": { "type": "string", "description": "AWS Region of distribution.\n" }, "s3ExportConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionS3ExportConfiguration:getDistributionConfigurationDistributionS3ExportConfiguration" }, "description": "Nested list of S3 export configuration.\n" } }, "type": "object", "required": [ "amiDistributionConfigurations", "containerDistributionConfigurations", "fastLaunchConfigurations", "launchTemplateConfigurations", "licenseConfigurationArns", "region", "s3ExportConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionAmiDistributionConfiguration:getDistributionConfigurationDistributionAmiDistributionConfiguration": { "properties": { "amiTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value map of tags to apply to distributed AMI.\n" }, "description": { "type": "string", "description": "Description of the container distribution configuration.\n" }, "kmsKeyId": { "type": "string", "description": "ARN of Key Management Service (KMS) Key to encrypt AMI.\n" }, "launchPermissions": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission:getDistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission" }, "description": "Nested list of EC2 launch permissions.\n" }, "name": { "type": "string", "description": "Name of the distribution configuration.\n" }, "targetAccountIds": { "type": "array", "items": { "type": "string" }, "description": "Set of target AWS Account identifiers.\n" } }, "type": "object", "required": [ "amiTags", "description", "kmsKeyId", "launchPermissions", "name", "targetAccountIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission:getDistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermission": { "properties": { "organizationArns": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Organization ARNs.\n" }, "organizationalUnitArns": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Organizational Unit ARNs.\n" }, "userGroups": { "type": "array", "items": { "type": "string" }, "description": "Set of EC2 launch permission user groups.\n" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "Set of AWS Account identifiers.\n" } }, "type": "object", "required": [ "organizationArns", "organizationalUnitArns", "userGroups", "userIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionContainerDistributionConfiguration:getDistributionConfigurationDistributionContainerDistributionConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" }, "description": "Set of tags that are attached to the container distribution configuration.\n" }, "description": { "type": "string", "description": "Description of the container distribution configuration.\n" }, "targetRepositories": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository:getDistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository" }, "description": "Set of destination repositories for the container distribution configuration.\n" } }, "type": "object", "required": [ "containerTags", "description", "targetRepositories" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository:getDistributionConfigurationDistributionContainerDistributionConfigurationTargetRepository": { "properties": { "repositoryName": { "type": "string", "description": "Name of the container repository where the output container image is stored.\n" }, "service": { "type": "string", "description": "Service in which the image is registered.\n" } }, "type": "object", "required": [ "repositoryName", "service" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfiguration:getDistributionConfigurationDistributionFastLaunchConfiguration": { "properties": { "accountId": { "type": "string", "description": "The account ID that this configuration applies to.\n" }, "enabled": { "type": "boolean", "description": "A Boolean that represents the current state of faster launching for the Windows AMI.\n" }, "launchTemplates": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate:getDistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate" }, "description": "Nested list of launch templates that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.\n" }, "maxParallelLaunches": { "type": "integer", "description": "The maximum number of parallel instances that are launched for creating resources.\n" }, "snapshotConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration:getDistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration" }, "description": "Nested list of configurations for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.\n" } }, "type": "object", "required": [ "accountId", "enabled", "launchTemplates", "maxParallelLaunches", "snapshotConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate:getDistributionConfigurationDistributionFastLaunchConfigurationLaunchTemplate": { "properties": { "launchTemplateId": { "type": "string", "description": "ID of the Amazon EC2 launch template.\n" }, "launchTemplateName": { "type": "string", "description": "The name of the launch template to use for faster launching for a Windows AMI.\n" }, "launchTemplateVersion": { "type": "string", "description": "The version of the launch template to use for faster launching for a Windows AMI.\n" } }, "type": "object", "required": [ "launchTemplateId", "launchTemplateName", "launchTemplateVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration:getDistributionConfigurationDistributionFastLaunchConfigurationSnapshotConfiguration": { "properties": { "targetResourceCount": { "type": "integer", "description": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.\n" } }, "type": "object", "required": [ "targetResourceCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionLaunchTemplateConfiguration:getDistributionConfigurationDistributionLaunchTemplateConfiguration": { "properties": { "accountId": { "type": "string", "description": "The account ID that this configuration applies to.\n" }, "default": { "type": "boolean", "description": "Whether the specified Amazon EC2 launch template is set as the default launch template.\n" }, "launchTemplateId": { "type": "string", "description": "ID of the Amazon EC2 launch template.\n" } }, "type": "object", "required": [ "accountId", "default", "launchTemplateId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationDistributionS3ExportConfiguration:getDistributionConfigurationDistributionS3ExportConfiguration": { "properties": { "diskImageFormat": { "type": "string", "description": "The disk image format of the exported image (`RAW`, `VHD`, or `VMDK`)\n" }, "roleName": { "type": "string", "description": "The name of the IAM role to use for exporting.\n" }, "s3Bucket": { "type": "string", "description": "The name of the S3 bucket to store the exported image in.\n" }, "s3Prefix": { "type": "string", "description": "The prefix for the exported image.\n" } }, "type": "object", "required": [ "diskImageFormat", "roleName", "s3Bucket", "s3Prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getDistributionConfigurationsFilter:getDistributionConfigurationsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListDistributionConfigurations API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListDistributionConfigurations.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:imagebuilder/getImageImageScanningConfiguration:getImageImageScanningConfiguration": { "properties": { "ecrConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImageImageScanningConfigurationEcrConfiguration:getImageImageScanningConfigurationEcrConfiguration" }, "description": "Configuration block with ECR configuration.\n" }, "imageScanningEnabled": { "type": "boolean", "description": "Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.\n" } }, "type": "object", "required": [ "ecrConfigurations", "imageScanningEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageImageScanningConfigurationEcrConfiguration:getImageImageScanningConfigurationEcrConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" }, "description": "Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.\n" }, "repositoryName": { "type": "string", "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images.\n" } }, "type": "object", "required": [ "containerTags", "repositoryName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageImageTestsConfiguration:getImageImageTestsConfiguration": { "properties": { "imageTestsEnabled": { "type": "boolean", "description": "Whether image tests are enabled.\n" }, "timeoutMinutes": { "type": "integer", "description": "Number of minutes before image tests time out.\n" } }, "type": "object", "required": [ "imageTestsEnabled", "timeoutMinutes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageOutputResource:getImageOutputResource": { "properties": { "amis": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImageOutputResourceAmi:getImageOutputResourceAmi" }, "description": "Set of objects with each Amazon Machine Image (AMI) created.\n" }, "containers": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImageOutputResourceContainer:getImageOutputResourceContainer" }, "description": "Set of objects with each container image created and stored in the output repository.\n" } }, "type": "object", "required": [ "amis", "containers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageOutputResourceAmi:getImageOutputResourceAmi": { "properties": { "accountId": { "type": "string", "description": "Account identifier of the AMI.\n" }, "description": { "type": "string", "description": "Description of the AMI.\n" }, "image": { "type": "string", "description": "Identifier of the AMI.\n" }, "name": { "type": "string", "description": "Name of the AMI.\n" }, "region": { "type": "string", "description": "Region of the container image.\n" } }, "type": "object", "required": [ "accountId", "description", "image", "name", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageOutputResourceContainer:getImageOutputResourceContainer": { "properties": { "imageUris": { "type": "array", "items": { "type": "string" }, "description": "Set of URIs for created containers.\n" }, "region": { "type": "string", "description": "Region of the container image.\n" } }, "type": "object", "required": [ "imageUris", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImagePipelineImageScanningConfiguration:getImagePipelineImageScanningConfiguration": { "properties": { "ecrConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImagePipelineImageScanningConfigurationEcrConfiguration:getImagePipelineImageScanningConfigurationEcrConfiguration" }, "description": "List if an object with ecr configuration for image scanning\n" }, "imageScanningEnabled": { "type": "boolean", "description": "Whether image scanning is enabled.\n" } }, "type": "object", "required": [ "ecrConfigurations", "imageScanningEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImagePipelineImageScanningConfigurationEcrConfiguration:getImagePipelineImageScanningConfigurationEcrConfiguration": { "properties": { "containerTags": { "type": "array", "items": { "type": "string" }, "description": "Tags that are added to the output containers that are scanned\n" }, "repositoryName": { "type": "string", "description": "The name of the container repository that Amazon Inspector scans\n" } }, "type": "object", "required": [ "containerTags", "repositoryName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImagePipelineImageTestsConfiguration:getImagePipelineImageTestsConfiguration": { "properties": { "imageTestsEnabled": { "type": "boolean", "description": "Whether image tests are enabled.\n" }, "timeoutMinutes": { "type": "integer", "description": "Number of minutes before image tests time out.\n" } }, "type": "object", "required": [ "imageTestsEnabled", "timeoutMinutes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImagePipelineSchedule:getImagePipelineSchedule": { "properties": { "pipelineExecutionStartCondition": { "type": "string", "description": "Condition when the pipeline should trigger a new image build.\n" }, "scheduleExpression": { "type": "string", "description": "Cron expression of how often the pipeline start condition is evaluated.\n" } }, "type": "object", "required": [ "pipelineExecutionStartCondition", "scheduleExpression" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImagePipelinesFilter:getImagePipelinesFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListImagePipelines API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListImagePipelines.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:imagebuilder/getImageRecipeBlockDeviceMapping:getImageRecipeBlockDeviceMapping": { "properties": { "deviceName": { "type": "string", "description": "Name of the device. For example, `/dev/sda` or `/dev/xvdb`.\n" }, "ebs": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImageRecipeBlockDeviceMappingEb:getImageRecipeBlockDeviceMappingEb" }, "description": "Single list of object with Elastic Block Storage (EBS) block device mapping settings.\n" }, "noDevice": { "type": "string", "description": "Whether to remove a mapping from the parent image.\n" }, "virtualName": { "type": "string", "description": "Virtual device name. For example, `ephemeral0`. Instance store volumes are numbered starting from 0.\n" } }, "type": "object", "required": [ "deviceName", "ebs", "noDevice", "virtualName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageRecipeBlockDeviceMappingEb:getImageRecipeBlockDeviceMappingEb": { "properties": { "deleteOnTermination": { "type": "string", "description": "Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.\n" }, "encrypted": { "type": "string", "description": "Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.\n" }, "iops": { "type": "integer", "description": "Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume.\n" }, "kmsKeyId": { "type": "string", "description": "ARN of the Key Management Service (KMS) Key for encryption.\n" }, "snapshotId": { "type": "string", "description": "Identifier of the EC2 Volume Snapshot.\n" }, "throughput": { "type": "integer", "description": "For GP3 volumes only. The throughput in MiB/s that the volume supports.\n" }, "volumeSize": { "type": "integer", "description": "Size of the volume, in GiB.\n" }, "volumeType": { "type": "string", "description": "Type of the volume. For example, `gp2` or `io2`.\n" } }, "type": "object", "required": [ "deleteOnTermination", "encrypted", "iops", "kmsKeyId", "snapshotId", "throughput", "volumeSize", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageRecipeComponent:getImageRecipeComponent": { "properties": { "componentArn": { "type": "string", "description": "ARN of the Image Builder Component.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getImageRecipeComponentParameter:getImageRecipeComponentParameter" }, "description": "Set of parameters that are used to configure the component.\n" } }, "type": "object", "required": [ "componentArn", "parameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageRecipeComponentParameter:getImageRecipeComponentParameter": { "properties": { "name": { "type": "string", "description": "Name of the image recipe.\n" }, "value": { "type": "string", "description": "Value of the component parameter.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getImageRecipesFilter:getImageRecipesFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListImageRecipes API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListImageRecipes.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:imagebuilder/getInfrastructureConfigurationInstanceMetadataOption:getInfrastructureConfigurationInstanceMetadataOption": { "properties": { "httpPutResponseHopLimit": { "type": "integer", "description": "Number of hops that an instance can traverse to reach its destonation.\n" }, "httpTokens": { "type": "string", "description": "Whether a signed token is required for instance metadata retrieval requests.\n" } }, "type": "object", "required": [ "httpPutResponseHopLimit", "httpTokens" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getInfrastructureConfigurationLogging:getInfrastructureConfigurationLogging": { "properties": { "s3Logs": { "type": "array", "items": { "$ref": "#/types/aws:imagebuilder/getInfrastructureConfigurationLoggingS3Log:getInfrastructureConfigurationLoggingS3Log" }, "description": "Nested list of S3 logs settings.\n" } }, "type": "object", "required": [ "s3Logs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getInfrastructureConfigurationLoggingS3Log:getInfrastructureConfigurationLoggingS3Log": { "properties": { "s3BucketName": { "type": "string", "description": "Name of the S3 Bucket for logging.\n" }, "s3KeyPrefix": { "type": "string", "description": "Key prefix for S3 Bucket logging.\n" } }, "type": "object", "required": [ "s3BucketName", "s3KeyPrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:imagebuilder/getInfrastructureConfigurationsFilter:getInfrastructureConfigurationsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [Image Builder ListInfrastructureConfigurations API Reference](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_ListInfrastructureConfigurations.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:index/ProviderAssumeRole:ProviderAssumeRole": { "properties": { "duration": { "type": "string", "description": "The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.\n" }, "externalId": { "type": "string", "description": "A unique identifier that might be required when you assume a role in another account.\n" }, "policy": { "type": "string", "description": "IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.\n" }, "policyArns": { "type": "array", "items": { "type": "string" }, "description": "Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.\n" }, "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.\n" }, "sessionName": { "type": "string", "description": "An identifier for the assumed role session.\n" }, "sourceIdentity": { "type": "string", "description": "Source identity specified by the principal assuming the role.\n" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Assume role session tags.\n" }, "transitiveTagKeys": { "type": "array", "items": { "type": "string" }, "description": "Assume role session tag keys to pass to any subsequent sessions.\n" } }, "type": "object" }, "aws:index/ProviderAssumeRoleWithWebIdentity:ProviderAssumeRoleWithWebIdentity": { "properties": { "duration": { "type": "string", "description": "The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.\n" }, "policy": { "type": "string", "description": "IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.\n" }, "policyArns": { "type": "array", "items": { "type": "string" }, "description": "Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.\n" }, "roleArn": { "type": "string", "description": "Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.\n" }, "sessionName": { "type": "string", "description": "An identifier for the assumed role session.\n" }, "webIdentityToken": { "type": "string" }, "webIdentityTokenFile": { "type": "string" } }, "type": "object" }, "aws:index/ProviderDefaultTags:ProviderDefaultTags": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags to default across all resources. Can also be configured with environment variables like `TF_AWS_DEFAULT_TAGS_\u003ctag_name\u003e`.\n" } }, "type": "object" }, "aws:index/ProviderEndpoint:ProviderEndpoint": { "properties": { "accessanalyzer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "account": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "acm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "acmpca": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amg": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amp": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "amplify": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apigateway": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apigatewayv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appautoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appconfig": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appfabric": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appflow": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appintegrations": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appintegrationsservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationautoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationinsights": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "applicationsignals": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appmesh": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appregistry": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "apprunner": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appstream": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "appsync": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "athena": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "auditmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "autoscaling": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "autoscalingplans": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "backup": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "batch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bcmdataexports": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "beanstalk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bedrock": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "bedrockagent": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "billing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "budgets": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ce": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chatbot": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chime": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chimesdkmediapipelines": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "chimesdkvoice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cleanrooms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloud9": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudcontrol": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudcontrolapi": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudformation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudfront": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudfrontkeyvaluestore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudhsm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudhsmv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudsearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudtrail": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchevents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchevidently": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchlog": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchlogs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchobservabilityaccessmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cloudwatchrum": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeartifact": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codebuild": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codecatalyst": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codecommit": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeconnections": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codedeploy": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codeguruprofiler": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codegurureviewer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codepipeline": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codestarconnections": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "codestarnotifications": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidentity": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidentityprovider": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cognitoidp": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "comprehend": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "computeoptimizer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "config": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "configservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "connect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "connectcases": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "controltower": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costandusagereportservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costexplorer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "costoptimizationhub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "cur": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "customerprofiles": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databasemigration": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databasemigrationservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "databrew": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dataexchange": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datapipeline": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datasync": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "datazone": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dax": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "deploy": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "detective": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "devicefarm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "devopsguru": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "directconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "directoryservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dlm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "docdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "docdbelastic": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "drs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ds": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dsql": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "dynamodb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ec2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecr": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecrpublic": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ecs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "efs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "eks": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticache": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticbeanstalk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticloadbalancing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticloadbalancingv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticsearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elasticsearchservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elastictranscoder": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "elbv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emr": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emrcontainers": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "emrserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "es": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "eventbridge": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "events": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "evidently": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "finspace": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "firehose": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "fsx": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "gamelift": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "glacier": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "globalaccelerator": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "glue": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "gluedatabrew": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "grafana": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "greengrass": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "groundstation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "guardduty": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "healthlake": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iam": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "identitystore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "imagebuilder": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspector": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspector2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "inspectorv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "internetmonitor": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "invoicing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iot": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iotanalytics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "iotevents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ivs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ivschat": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kafka": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kafkaconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kendra": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "keyspaces": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisanalytics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisanalyticsv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kinesisvideo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "kms": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lakeformation": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lambda": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "launchwizard": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lex": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelbuilding": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelbuildingservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodels": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexmodelsv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lexv2models": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "licensemanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lightsail": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "location": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "locationservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "logs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "lookoutmetrics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "m2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "macie2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "managedgrafana": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediaconnect": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediaconvert": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "medialive": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackage": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackagev2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediapackagevod": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mediastore": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "memorydb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mgn": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mq": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "msk": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "mwaa": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "neptune": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "neptunegraph": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkfirewall": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "networkmonitor": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "oam": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearch": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchingestion": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opensearchservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "opsworks": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "organizations": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "osis": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "outposts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "paymentcryptography": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pcaconnectorad": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pcs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pinpoint": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pinpointsmsvoicev2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pipes": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "polly": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "pricing": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "prometheus": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "prometheusservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "qbusiness": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "qldb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "quicksight": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ram": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rbin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rds": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "recyclebin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshift": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftdata": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftdataapiservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "redshiftserverless": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rekognition": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resiliencehub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourceexplorer2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroups": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroupstagging": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "resourcegroupstaggingapi": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rolesanywhere": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53domains": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53profiles": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53recoverycontrolconfig": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53recoveryreadiness": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "route53resolver": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "rum": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3api": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3control": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3outposts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "s3tables": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sagemaker": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "scheduler": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "schemas": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "secretsmanager": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "securityhub": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "securitylake": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessapplicationrepository": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessapprepo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "serverlessrepo": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicecatalog": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicecatalogappregistry": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicediscovery": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "servicequotas": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ses": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sesv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sfn": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "shield": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "signer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "simpledb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sns": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sqs": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssm": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmcontacts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmincidents": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmquicksetup": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssmsap": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sso": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "ssoadmin": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "stepfunctions": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "storagegateway": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "sts": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "swf": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "synthetics": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "taxsettings": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreaminfluxdb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreamquery": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "timestreamwrite": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transcribe": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transcribeservice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "transfer": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "verifiedpermissions": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "vpclattice": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "waf": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wafregional": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wafv2": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "wellarchitected": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "worklink": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "workspaces": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "workspacesweb": { "type": "string", "description": "Use this to override the default service endpoint URL\n" }, "xray": { "type": "string", "description": "Use this to override the default service endpoint URL\n" } }, "type": "object" }, "aws:index/ProviderIgnoreTags:ProviderIgnoreTags": { "properties": { "keyPrefixes": { "type": "array", "items": { "type": "string" }, "description": "Resource tag key prefixes to ignore across all resources. Can also be configured with the TF_AWS_IGNORE_TAGS_KEY_PREFIXES environment variable.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Resource tag keys to ignore across all resources. Can also be configured with the TF_AWS_IGNORE_TAGS_KEYS environment variable.\n" } }, "type": "object" }, "aws:index/Region:Region": { "description": "A Region represents any valid Amazon region that may be targeted with deployments.", "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": "APNortheast3", "value": "ap-northeast-3" }, { "name": "APSouth1", "value": "ap-south-1" }, { "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": "APSoutheast4", "value": "ap-southeast-4" }, { "name": "APSoutheast5", "value": "ap-southeast-5" }, { "name": "APSoutheast7", "value": "ap-southeast-7" }, { "name": "CACentral", "value": "ca-central-1" }, { "name": "CAWest1", "value": "ca-west-1" }, { "name": "EUCentral1", "value": "eu-central-1" }, { "name": "EUCentral2", "value": "eu-central-2" }, { "name": "EUNorth1", "value": "eu-north-1" }, { "name": "EUSouth1", "value": "eu-south-1" }, { "name": "EUSouth2", "value": "eu-south-2" }, { "name": "EUWest1", "value": "eu-west-1" }, { "name": "EUWest2", "value": "eu-west-2" }, { "name": "EUWest3", "value": "eu-west-3" }, { "name": "ILCentral1", "value": "il-central-1" }, { "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" }, { "name": "CNNorth1", "value": "cn-north-1" }, { "name": "CNNorthwest1", "value": "cn-northwest-1" }, { "name": "USGovEast1", "value": "us-gov-east-1" }, { "name": "USGovWest1", "value": "us-gov-west-1" }, { "name": "USISOEast1", "value": "us-iso-east-1" }, { "name": "USISOWest1", "value": "us-iso-west-1" }, { "name": "USISOBEast1", "value": "us-isob-east-1" }, { "name": "EUISOEWest1", "value": "eu-isoe-west-1" } ] }, "aws:index/getAvailabilityZoneFilter:getAvailabilityZoneFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeAvailabilityZones API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:index/getAvailabilityZonesFilter:getAvailabilityZonesFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [EC2 DescribeAvailabilityZones API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html).\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:index/getRegionsFilter:getRegionsFilter": { "properties": { "name": { "type": "string", "description": "Name of the filter field. Valid values can be found in the [describe-regions AWS CLI Reference][1].\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of values that are accepted for the given filter field. Results will be selected if any given value matches.\n" } }, "type": "object", "required": [ "name", "values" ] }, "aws:inspector/AssessmentTemplateEventSubscription:AssessmentTemplateEventSubscription": { "properties": { "event": { "type": "string", "description": "The event for which you want to receive SNS notifications. Valid values are `ASSESSMENT_RUN_STARTED`, `ASSESSMENT_RUN_COMPLETED`, `ASSESSMENT_RUN_STATE_CHANGED`, and `FINDING_REPORTED`.\n" }, "topicArn": { "type": "string", "description": "The ARN of the SNS topic to which notifications are sent.\n" } }, "type": "object", "required": [ "event", "topicArn" ] }, "aws:inspector2/OrganizationConfigurationAutoEnable:OrganizationConfigurationAutoEnable": { "properties": { "ec2": { "type": "boolean", "description": "Whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.\n" }, "ecr": { "type": "boolean", "description": "Whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.\n" }, "lambda": { "type": "boolean", "description": "Whether Lambda Function scans are automatically enabled for new members of your Amazon Inspector organization.\n" }, "lambdaCode": { "type": "boolean", "description": "Whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization. **Note:** Lambda code scanning requires Lambda standard scanning to be activated. Consequently, if you are setting this argument to `true`, you must also set the `lambda` argument to `true`. See [Scanning AWS Lambda functions with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-lambda.html#lambda-code-scans) for more information.\n" } }, "type": "object", "required": [ "ec2", "ecr" ] }, "aws:iot/BillingGroupMetadata:BillingGroupMetadata": { "properties": { "creationDate": { "type": "string" } }, "type": "object", "required": [ "creationDate" ] }, "aws:iot/BillingGroupProperties:BillingGroupProperties": { "properties": { "description": { "type": "string", "description": "A description of the Billing Group.\n" } }, "type": "object" }, "aws:iot/CaCertificateRegistrationConfig:CaCertificateRegistrationConfig": { "properties": { "roleArn": { "type": "string", "description": "The ARN of the role.\n" }, "templateBody": { "type": "string", "description": "The template body.\n" }, "templateName": { "type": "string", "description": "The name of the provisioning template.\n" } }, "type": "object" }, "aws:iot/CaCertificateValidity:CaCertificateValidity": { "properties": { "notAfter": { "type": "string", "description": "The certificate is not valid after this date.\n" }, "notBefore": { "type": "string", "description": "The certificate is not valid before this date.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "notAfter", "notBefore" ] } } }, "aws:iot/DomainConfigurationAuthorizerConfig:DomainConfigurationAuthorizerConfig": { "properties": { "allowAuthorizerOverride": { "type": "boolean", "description": "A Boolean that specifies whether the domain configuration's authorization service can be overridden.\n" }, "defaultAuthorizerName": { "type": "string", "description": "The name of the authorization service for a domain configuration.\n" } }, "type": "object" }, "aws:iot/DomainConfigurationTlsConfig:DomainConfigurationTlsConfig": { "properties": { "securityPolicy": { "type": "string", "description": "The security policy for a domain configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityPolicy" ] } } }, "aws:iot/IndexingConfigurationThingGroupIndexingConfiguration:IndexingConfigurationThingGroupIndexingConfiguration": { "properties": { "customFields": { "type": "array", "items": { "$ref": "#/types/aws:iot/IndexingConfigurationThingGroupIndexingConfigurationCustomField:IndexingConfigurationThingGroupIndexingConfigurationCustomField" }, "description": "A list of thing group fields to index. This list cannot contain any managed fields. See below.\n" }, "managedFields": { "type": "array", "items": { "$ref": "#/types/aws:iot/IndexingConfigurationThingGroupIndexingConfigurationManagedField:IndexingConfigurationThingGroupIndexingConfigurationManagedField" }, "description": "Contains fields that are indexed and whose types are already known by the Fleet Indexing service. See below.\n" }, "thingGroupIndexingMode": { "type": "string", "description": "Thing group indexing mode. Valid values: `OFF`, `ON`.\n" } }, "type": "object", "required": [ "thingGroupIndexingMode" ], "language": { "nodejs": { "requiredOutputs": [ "managedFields", "thingGroupIndexingMode" ] } } }, "aws:iot/IndexingConfigurationThingGroupIndexingConfigurationCustomField:IndexingConfigurationThingGroupIndexingConfigurationCustomField": { "properties": { "name": { "type": "string", "description": "The name of the field.\n" }, "type": { "type": "string", "description": "The data type of the field. Valid values: `Number`, `String`, `Boolean`.\n" } }, "type": "object" }, "aws:iot/IndexingConfigurationThingGroupIndexingConfigurationManagedField:IndexingConfigurationThingGroupIndexingConfigurationManagedField": { "properties": { "name": { "type": "string", "description": "The name of the field.\n" }, "type": { "type": "string", "description": "The data type of the field. Valid values: `Number`, `String`, `Boolean`.\n" } }, "type": "object" }, "aws:iot/IndexingConfigurationThingIndexingConfiguration:IndexingConfigurationThingIndexingConfiguration": { "properties": { "customFields": { "type": "array", "items": { "$ref": "#/types/aws:iot/IndexingConfigurationThingIndexingConfigurationCustomField:IndexingConfigurationThingIndexingConfigurationCustomField" }, "description": "Contains custom field names and their data type. See below.\n" }, "deviceDefenderIndexingMode": { "type": "string", "description": "Device Defender indexing mode. Valid values: `VIOLATIONS`, `OFF`. Default: `OFF`.\n" }, "filter": { "$ref": "#/types/aws:iot/IndexingConfigurationThingIndexingConfigurationFilter:IndexingConfigurationThingIndexingConfigurationFilter", "description": "Required if `named_shadow_indexing_mode` is `ON`. Enables to add named shadows filtered by `filter` to fleet indexing configuration.\n" }, "managedFields": { "type": "array", "items": { "$ref": "#/types/aws:iot/IndexingConfigurationThingIndexingConfigurationManagedField:IndexingConfigurationThingIndexingConfigurationManagedField" }, "description": "Contains fields that are indexed and whose types are already known by the Fleet Indexing service. See below.\n" }, "namedShadowIndexingMode": { "type": "string", "description": "[Named shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) indexing mode. Valid values: `ON`, `OFF`. Default: `OFF`.\n" }, "thingConnectivityIndexingMode": { "type": "string", "description": "Thing connectivity indexing mode. Valid values: `STATUS`, `OFF`. Default: `OFF`.\n" }, "thingIndexingMode": { "type": "string", "description": "Thing indexing mode. Valid values: `REGISTRY`, `REGISTRY_AND_SHADOW`, `OFF`.\n" } }, "type": "object", "required": [ "thingIndexingMode" ], "language": { "nodejs": { "requiredOutputs": [ "filter", "managedFields", "thingIndexingMode" ] } } }, "aws:iot/IndexingConfigurationThingIndexingConfigurationCustomField:IndexingConfigurationThingIndexingConfigurationCustomField": { "properties": { "name": { "type": "string", "description": "The name of the field.\n" }, "type": { "type": "string", "description": "The data type of the field. Valid values: `Number`, `String`, `Boolean`.\n" } }, "type": "object" }, "aws:iot/IndexingConfigurationThingIndexingConfigurationFilter:IndexingConfigurationThingIndexingConfigurationFilter": { "properties": { "namedShadowNames": { "type": "array", "items": { "type": "string" }, "description": "List of shadow names that you select to index.\n" } }, "type": "object" }, "aws:iot/IndexingConfigurationThingIndexingConfigurationManagedField:IndexingConfigurationThingIndexingConfigurationManagedField": { "properties": { "name": { "type": "string", "description": "The name of the field.\n" }, "type": { "type": "string", "description": "The data type of the field. Valid values: `Number`, `String`, `Boolean`.\n" } }, "type": "object" }, "aws:iot/ProvisioningTemplatePreProvisioningHook:ProvisioningTemplatePreProvisioningHook": { "properties": { "payloadVersion": { "type": "string", "description": "The version of the payload that was sent to the target function. The only valid (and the default) payload version is `\"2020-04-01\"`.\n" }, "targetArn": { "type": "string", "description": "The ARN of the target function.\n" } }, "type": "object", "required": [ "targetArn" ] }, "aws:iot/ThingGroupMetadata:ThingGroupMetadata": { "properties": { "creationDate": { "type": "string" }, "parentGroupName": { "type": "string", "description": "The name of the parent Thing Group.\n" }, "rootToParentGroups": { "type": "array", "items": { "$ref": "#/types/aws:iot/ThingGroupMetadataRootToParentGroup:ThingGroupMetadataRootToParentGroup" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creationDate", "parentGroupName", "rootToParentGroups" ] } } }, "aws:iot/ThingGroupMetadataRootToParentGroup:ThingGroupMetadataRootToParentGroup": { "properties": { "groupArn": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "groupArn", "groupName" ] } } }, "aws:iot/ThingGroupProperties:ThingGroupProperties": { "properties": { "attributePayload": { "$ref": "#/types/aws:iot/ThingGroupPropertiesAttributePayload:ThingGroupPropertiesAttributePayload", "description": "The Thing Group attributes. Defined below.\n" }, "description": { "type": "string", "description": "A description of the Thing Group.\n" } }, "type": "object" }, "aws:iot/ThingGroupPropertiesAttributePayload:ThingGroupPropertiesAttributePayload": { "properties": { "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value map.\n" } }, "type": "object" }, "aws:iot/ThingTypeProperties:ThingTypeProperties": { "properties": { "description": { "type": "string", "description": "The description of the thing type.\n", "willReplaceOnChanges": true }, "searchableAttributes": { "type": "array", "items": { "type": "string" }, "description": "A list of searchable thing attribute names.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "searchableAttributes" ] } } }, "aws:iot/TopicRuleCloudwatchAlarm:TopicRuleCloudwatchAlarm": { "properties": { "alarmName": { "type": "string", "description": "The CloudWatch alarm name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch alarm.\n" }, "stateReason": { "type": "string", "description": "The reason for the alarm change.\n" }, "stateValue": { "type": "string", "description": "The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.\n" } }, "type": "object", "required": [ "alarmName", "roleArn", "stateReason", "stateValue" ] }, "aws:iot/TopicRuleCloudwatchLog:TopicRuleCloudwatchLog": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch log group name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch alarm.\n" } }, "type": "object", "required": [ "logGroupName", "roleArn" ] }, "aws:iot/TopicRuleCloudwatchMetric:TopicRuleCloudwatchMetric": { "properties": { "metricName": { "type": "string", "description": "The CloudWatch metric name.\n" }, "metricNamespace": { "type": "string", "description": "The CloudWatch metric namespace name.\n" }, "metricTimestamp": { "type": "string", "description": "An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).\n" }, "metricUnit": { "type": "string", "description": "The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)\n" }, "metricValue": { "type": "string", "description": "The CloudWatch metric value.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch metric.\n" } }, "type": "object", "required": [ "metricName", "metricNamespace", "metricUnit", "metricValue", "roleArn" ] }, "aws:iot/TopicRuleDestinationVpcConfiguration:TopicRuleDestinationVpcConfiguration": { "properties": { "roleArn": { "type": "string", "description": "The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).\n", "willReplaceOnChanges": true }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "The security groups of the VPC destination.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The subnet IDs of the VPC destination.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The ID of the VPC.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "roleArn", "subnetIds", "vpcId" ] }, "aws:iot/TopicRuleDynamodb:TopicRuleDynamodb": { "properties": { "hashKeyField": { "type": "string", "description": "The hash key name.\n" }, "hashKeyType": { "type": "string", "description": "The hash key type. Valid values are \"STRING\" or \"NUMBER\".\n" }, "hashKeyValue": { "type": "string", "description": "The hash key value.\n" }, "operation": { "type": "string", "description": "The operation. Valid values are \"INSERT\", \"UPDATE\", or \"DELETE\".\n" }, "payloadField": { "type": "string", "description": "The action payload.\n" }, "rangeKeyField": { "type": "string", "description": "The range key name.\n" }, "rangeKeyType": { "type": "string", "description": "The range key type. Valid values are \"STRING\" or \"NUMBER\".\n" }, "rangeKeyValue": { "type": "string", "description": "The range key value.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the DynamoDB table.\n" }, "tableName": { "type": "string", "description": "The name of the DynamoDB table.\n" } }, "type": "object", "required": [ "hashKeyField", "hashKeyValue", "roleArn", "tableName" ] }, "aws:iot/TopicRuleDynamodbv2:TopicRuleDynamodbv2": { "properties": { "putItem": { "$ref": "#/types/aws:iot/TopicRuleDynamodbv2PutItem:TopicRuleDynamodbv2PutItem", "description": "Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the DynamoDB table.\n" } }, "type": "object", "required": [ "roleArn" ] }, "aws:iot/TopicRuleDynamodbv2PutItem:TopicRuleDynamodbv2PutItem": { "properties": { "tableName": { "type": "string", "description": "The name of the DynamoDB table.\n" } }, "type": "object", "required": [ "tableName" ] }, "aws:iot/TopicRuleElasticsearch:TopicRuleElasticsearch": { "properties": { "endpoint": { "type": "string", "description": "The endpoint of your Elasticsearch domain.\n" }, "id": { "type": "string", "description": "The unique identifier for the document you are storing.\n" }, "index": { "type": "string", "description": "The Elasticsearch index where you want to store your data.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that has access to Elasticsearch.\n" }, "type": { "type": "string", "description": "The type of document you are storing.\n" } }, "type": "object", "required": [ "endpoint", "id", "index", "roleArn", "type" ] }, "aws:iot/TopicRuleErrorAction:TopicRuleErrorAction": { "properties": { "cloudwatchAlarm": { "$ref": "#/types/aws:iot/TopicRuleErrorActionCloudwatchAlarm:TopicRuleErrorActionCloudwatchAlarm" }, "cloudwatchLogs": { "$ref": "#/types/aws:iot/TopicRuleErrorActionCloudwatchLogs:TopicRuleErrorActionCloudwatchLogs" }, "cloudwatchMetric": { "$ref": "#/types/aws:iot/TopicRuleErrorActionCloudwatchMetric:TopicRuleErrorActionCloudwatchMetric" }, "dynamodb": { "$ref": "#/types/aws:iot/TopicRuleErrorActionDynamodb:TopicRuleErrorActionDynamodb" }, "dynamodbv2": { "$ref": "#/types/aws:iot/TopicRuleErrorActionDynamodbv2:TopicRuleErrorActionDynamodbv2" }, "elasticsearch": { "$ref": "#/types/aws:iot/TopicRuleErrorActionElasticsearch:TopicRuleErrorActionElasticsearch" }, "firehose": { "$ref": "#/types/aws:iot/TopicRuleErrorActionFirehose:TopicRuleErrorActionFirehose" }, "http": { "$ref": "#/types/aws:iot/TopicRuleErrorActionHttp:TopicRuleErrorActionHttp" }, "iotAnalytics": { "$ref": "#/types/aws:iot/TopicRuleErrorActionIotAnalytics:TopicRuleErrorActionIotAnalytics" }, "iotEvents": { "$ref": "#/types/aws:iot/TopicRuleErrorActionIotEvents:TopicRuleErrorActionIotEvents" }, "kafka": { "$ref": "#/types/aws:iot/TopicRuleErrorActionKafka:TopicRuleErrorActionKafka" }, "kinesis": { "$ref": "#/types/aws:iot/TopicRuleErrorActionKinesis:TopicRuleErrorActionKinesis" }, "lambda": { "$ref": "#/types/aws:iot/TopicRuleErrorActionLambda:TopicRuleErrorActionLambda" }, "republish": { "$ref": "#/types/aws:iot/TopicRuleErrorActionRepublish:TopicRuleErrorActionRepublish" }, "s3": { "$ref": "#/types/aws:iot/TopicRuleErrorActionS3:TopicRuleErrorActionS3" }, "sns": { "$ref": "#/types/aws:iot/TopicRuleErrorActionSns:TopicRuleErrorActionSns" }, "sqs": { "$ref": "#/types/aws:iot/TopicRuleErrorActionSqs:TopicRuleErrorActionSqs" }, "stepFunctions": { "$ref": "#/types/aws:iot/TopicRuleErrorActionStepFunctions:TopicRuleErrorActionStepFunctions" }, "timestream": { "$ref": "#/types/aws:iot/TopicRuleErrorActionTimestream:TopicRuleErrorActionTimestream" } }, "type": "object" }, "aws:iot/TopicRuleErrorActionCloudwatchAlarm:TopicRuleErrorActionCloudwatchAlarm": { "properties": { "alarmName": { "type": "string", "description": "The CloudWatch alarm name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch alarm.\n" }, "stateReason": { "type": "string", "description": "The reason for the alarm change.\n" }, "stateValue": { "type": "string", "description": "The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.\n" } }, "type": "object", "required": [ "alarmName", "roleArn", "stateReason", "stateValue" ] }, "aws:iot/TopicRuleErrorActionCloudwatchLogs:TopicRuleErrorActionCloudwatchLogs": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch log group name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch alarm.\n" } }, "type": "object", "required": [ "logGroupName", "roleArn" ] }, "aws:iot/TopicRuleErrorActionCloudwatchMetric:TopicRuleErrorActionCloudwatchMetric": { "properties": { "metricName": { "type": "string", "description": "The CloudWatch metric name.\n" }, "metricNamespace": { "type": "string", "description": "The CloudWatch metric namespace name.\n" }, "metricTimestamp": { "type": "string", "description": "An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).\n" }, "metricUnit": { "type": "string", "description": "The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)\n" }, "metricValue": { "type": "string", "description": "The CloudWatch metric value.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that allows access to the CloudWatch metric.\n" } }, "type": "object", "required": [ "metricName", "metricNamespace", "metricUnit", "metricValue", "roleArn" ] }, "aws:iot/TopicRuleErrorActionDynamodb:TopicRuleErrorActionDynamodb": { "properties": { "hashKeyField": { "type": "string", "description": "The hash key name.\n" }, "hashKeyType": { "type": "string", "description": "The hash key type. Valid values are \"STRING\" or \"NUMBER\".\n" }, "hashKeyValue": { "type": "string", "description": "The hash key value.\n" }, "operation": { "type": "string", "description": "The operation. Valid values are \"INSERT\", \"UPDATE\", or \"DELETE\".\n" }, "payloadField": { "type": "string", "description": "The action payload.\n" }, "rangeKeyField": { "type": "string", "description": "The range key name.\n" }, "rangeKeyType": { "type": "string", "description": "The range key type. Valid values are \"STRING\" or \"NUMBER\".\n" }, "rangeKeyValue": { "type": "string", "description": "The range key value.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the DynamoDB table.\n" }, "tableName": { "type": "string", "description": "The name of the DynamoDB table.\n" } }, "type": "object", "required": [ "hashKeyField", "hashKeyValue", "roleArn", "tableName" ] }, "aws:iot/TopicRuleErrorActionDynamodbv2:TopicRuleErrorActionDynamodbv2": { "properties": { "putItem": { "$ref": "#/types/aws:iot/TopicRuleErrorActionDynamodbv2PutItem:TopicRuleErrorActionDynamodbv2PutItem", "description": "Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the DynamoDB table.\n" } }, "type": "object", "required": [ "roleArn" ] }, "aws:iot/TopicRuleErrorActionDynamodbv2PutItem:TopicRuleErrorActionDynamodbv2PutItem": { "properties": { "tableName": { "type": "string", "description": "The name of the DynamoDB table.\n" } }, "type": "object", "required": [ "tableName" ] }, "aws:iot/TopicRuleErrorActionElasticsearch:TopicRuleErrorActionElasticsearch": { "properties": { "endpoint": { "type": "string", "description": "The endpoint of your Elasticsearch domain.\n" }, "id": { "type": "string", "description": "The unique identifier for the document you are storing.\n" }, "index": { "type": "string", "description": "The Elasticsearch index where you want to store your data.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that has access to Elasticsearch.\n" }, "type": { "type": "string", "description": "The type of document you are storing.\n" } }, "type": "object", "required": [ "endpoint", "id", "index", "roleArn", "type" ] }, "aws:iot/TopicRuleErrorActionFirehose:TopicRuleErrorActionFirehose": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.\n" }, "deliveryStreamName": { "type": "string", "description": "The delivery stream name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.\n" }, "separator": { "type": "string", "description": "A character separator that is used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).\n" } }, "type": "object", "required": [ "deliveryStreamName", "roleArn" ] }, "aws:iot/TopicRuleErrorActionHttp:TopicRuleErrorActionHttp": { "properties": { "confirmationUrl": { "type": "string", "description": "The HTTPS URL used to verify ownership of `url`.\n" }, "httpHeaders": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleErrorActionHttpHttpHeader:TopicRuleErrorActionHttpHttpHeader" }, "description": "Custom HTTP header IoT Core should send. It is possible to define more than one custom header.\n" }, "url": { "type": "string", "description": "The HTTPS URL.\n" } }, "type": "object", "required": [ "url" ] }, "aws:iot/TopicRuleErrorActionHttpHttpHeader:TopicRuleErrorActionHttpHttpHeader": { "properties": { "key": { "type": "string", "description": "The name of the HTTP header.\n" }, "value": { "type": "string", "description": "The value of the HTTP header.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:iot/TopicRuleErrorActionIotAnalytics:TopicRuleErrorActionIotAnalytics": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.\n" }, "channelName": { "type": "string", "description": "Name of AWS IOT Analytics channel.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "channelName", "roleArn" ] }, "aws:iot/TopicRuleErrorActionIotEvents:TopicRuleErrorActionIotEvents": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to IoT Events via a batch call.\n" }, "inputName": { "type": "string", "description": "The name of the AWS IoT Events input.\n" }, "messageId": { "type": "string", "description": "Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "inputName", "roleArn" ] }, "aws:iot/TopicRuleErrorActionKafka:TopicRuleErrorActionKafka": { "properties": { "clientProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties of the Apache Kafka producer client. For more info, see the [AWS documentation](https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html).\n" }, "destinationArn": { "type": "string", "description": "The ARN of Kafka action's VPC `aws.iot.TopicRuleDestination`.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleErrorActionKafkaHeader:TopicRuleErrorActionKafkaHeader" }, "description": "The list of Kafka headers that you specify. Nested arguments below.\n" }, "key": { "type": "string", "description": "The Kafka message key.\n" }, "partition": { "type": "string", "description": "The Kafka message partition.\n" }, "topic": { "type": "string", "description": "The Kafka topic for messages to be sent to the Kafka broker.\n" } }, "type": "object", "required": [ "clientProperties", "destinationArn", "topic" ] }, "aws:iot/TopicRuleErrorActionKafkaHeader:TopicRuleErrorActionKafkaHeader": { "properties": { "key": { "type": "string", "description": "The key of the Kafka header.\n" }, "value": { "type": "string", "description": "The value of the Kafka header.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:iot/TopicRuleErrorActionKinesis:TopicRuleErrorActionKinesis": { "properties": { "partitionKey": { "type": "string", "description": "The partition key.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the Amazon Kinesis stream.\n" }, "streamName": { "type": "string", "description": "The name of the Amazon Kinesis stream.\n" } }, "type": "object", "required": [ "roleArn", "streamName" ] }, "aws:iot/TopicRuleErrorActionLambda:TopicRuleErrorActionLambda": { "properties": { "functionArn": { "type": "string", "description": "The ARN of the Lambda function.\n" } }, "type": "object", "required": [ "functionArn" ] }, "aws:iot/TopicRuleErrorActionRepublish:TopicRuleErrorActionRepublish": { "properties": { "qos": { "type": "integer", "description": "The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "topic": { "type": "string", "description": "The name of the MQTT topic the message should be republished to.\n" } }, "type": "object", "required": [ "roleArn", "topic" ] }, "aws:iot/TopicRuleErrorActionS3:TopicRuleErrorActionS3": { "properties": { "bucketName": { "type": "string", "description": "The Amazon S3 bucket name.\n" }, "cannedAcl": { "type": "string", "description": "The Amazon S3 canned ACL that controls access to the object identified by the object key. [Valid values](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl).\n" }, "key": { "type": "string", "description": "The object key.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "bucketName", "key", "roleArn" ] }, "aws:iot/TopicRuleErrorActionSns:TopicRuleErrorActionSns": { "properties": { "messageFormat": { "type": "string", "description": "The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\".\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "targetArn": { "type": "string", "description": "The ARN of the SNS topic.\n" } }, "type": "object", "required": [ "roleArn", "targetArn" ] }, "aws:iot/TopicRuleErrorActionSqs:TopicRuleErrorActionSqs": { "properties": { "queueUrl": { "type": "string", "description": "The URL of the Amazon SQS queue.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "useBase64": { "type": "boolean", "description": "Specifies whether to use Base64 encoding.\n" } }, "type": "object", "required": [ "queueUrl", "roleArn", "useBase64" ] }, "aws:iot/TopicRuleErrorActionStepFunctions:TopicRuleErrorActionStepFunctions": { "properties": { "executionNamePrefix": { "type": "string", "description": "The prefix used to generate, along with a UUID, the unique state machine execution name.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to start execution of the state machine.\n" }, "stateMachineName": { "type": "string", "description": "The name of the Step Functions state machine whose execution will be started.\n" } }, "type": "object", "required": [ "roleArn", "stateMachineName" ] }, "aws:iot/TopicRuleErrorActionTimestream:TopicRuleErrorActionTimestream": { "properties": { "databaseName": { "type": "string", "description": "The name of an Amazon Timestream database.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleErrorActionTimestreamDimension:TopicRuleErrorActionTimestreamDimension" }, "description": "Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.\n" }, "roleArn": { "type": "string", "description": "The ARN of the role that grants permission to write to the Amazon Timestream database table.\n" }, "tableName": { "type": "string", "description": "The name of the database table into which to write the measure records.\n" }, "timestamp": { "$ref": "#/types/aws:iot/TopicRuleErrorActionTimestreamTimestamp:TopicRuleErrorActionTimestreamTimestamp", "description": "Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.\n" } }, "type": "object", "required": [ "databaseName", "dimensions", "roleArn", "tableName" ] }, "aws:iot/TopicRuleErrorActionTimestreamDimension:TopicRuleErrorActionTimestreamDimension": { "properties": { "name": { "type": "string", "description": "The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.\n" }, "value": { "type": "string", "description": "The value to write in this column of the database record.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:iot/TopicRuleErrorActionTimestreamTimestamp:TopicRuleErrorActionTimestreamTimestamp": { "properties": { "unit": { "type": "string", "description": "The precision of the timestamp value that results from the expression described in value. Valid values: `SECONDS`, `MILLISECONDS`, `MICROSECONDS`, `NANOSECONDS`.\n" }, "value": { "type": "string", "description": "An expression that returns a long epoch time value.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:iot/TopicRuleFirehose:TopicRuleFirehose": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.\n" }, "deliveryStreamName": { "type": "string", "description": "The delivery stream name.\n" }, "roleArn": { "type": "string", "description": "The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.\n" }, "separator": { "type": "string", "description": "A character separator that is used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).\n" } }, "type": "object", "required": [ "deliveryStreamName", "roleArn" ] }, "aws:iot/TopicRuleHttp:TopicRuleHttp": { "properties": { "confirmationUrl": { "type": "string", "description": "The HTTPS URL used to verify ownership of `url`.\n" }, "httpHeaders": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleHttpHttpHeader:TopicRuleHttpHttpHeader" }, "description": "Custom HTTP header IoT Core should send. It is possible to define more than one custom header.\n" }, "url": { "type": "string", "description": "The HTTPS URL.\n" } }, "type": "object", "required": [ "url" ] }, "aws:iot/TopicRuleHttpHttpHeader:TopicRuleHttpHttpHeader": { "properties": { "key": { "type": "string", "description": "The name of the HTTP header.\n" }, "value": { "type": "string", "description": "The value of the HTTP header.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:iot/TopicRuleIotAnalytic:TopicRuleIotAnalytic": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.\n" }, "channelName": { "type": "string", "description": "Name of AWS IOT Analytics channel.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "channelName", "roleArn" ] }, "aws:iot/TopicRuleIotEvent:TopicRuleIotEvent": { "properties": { "batchMode": { "type": "boolean", "description": "The payload that contains a JSON array of records will be sent to IoT Events via a batch call.\n" }, "inputName": { "type": "string", "description": "The name of the AWS IoT Events input.\n" }, "messageId": { "type": "string", "description": "Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "inputName", "roleArn" ] }, "aws:iot/TopicRuleKafka:TopicRuleKafka": { "properties": { "clientProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties of the Apache Kafka producer client. For more info, see the [AWS documentation](https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html).\n" }, "destinationArn": { "type": "string", "description": "The ARN of Kafka action's VPC `aws.iot.TopicRuleDestination`.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleKafkaHeader:TopicRuleKafkaHeader" }, "description": "The list of Kafka headers that you specify. Nested arguments below.\n" }, "key": { "type": "string", "description": "The Kafka message key.\n" }, "partition": { "type": "string", "description": "The Kafka message partition.\n" }, "topic": { "type": "string", "description": "The Kafka topic for messages to be sent to the Kafka broker.\n" } }, "type": "object", "required": [ "clientProperties", "destinationArn", "topic" ] }, "aws:iot/TopicRuleKafkaHeader:TopicRuleKafkaHeader": { "properties": { "key": { "type": "string", "description": "The key of the Kafka header.\n" }, "value": { "type": "string", "description": "The value of the Kafka header.\n" } }, "type": "object", "required": [ "key", "value" ] }, "aws:iot/TopicRuleKinesis:TopicRuleKinesis": { "properties": { "partitionKey": { "type": "string", "description": "The partition key.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to the Amazon Kinesis stream.\n" }, "streamName": { "type": "string", "description": "The name of the Amazon Kinesis stream.\n" } }, "type": "object", "required": [ "roleArn", "streamName" ] }, "aws:iot/TopicRuleLambda:TopicRuleLambda": { "properties": { "functionArn": { "type": "string", "description": "The ARN of the Lambda function.\n" } }, "type": "object", "required": [ "functionArn" ] }, "aws:iot/TopicRuleRepublish:TopicRuleRepublish": { "properties": { "qos": { "type": "integer", "description": "The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "topic": { "type": "string", "description": "The name of the MQTT topic the message should be republished to.\n" } }, "type": "object", "required": [ "roleArn", "topic" ] }, "aws:iot/TopicRuleS3:TopicRuleS3": { "properties": { "bucketName": { "type": "string", "description": "The Amazon S3 bucket name.\n" }, "cannedAcl": { "type": "string", "description": "The Amazon S3 canned ACL that controls access to the object identified by the object key. [Valid values](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl).\n" }, "key": { "type": "string", "description": "The object key.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" } }, "type": "object", "required": [ "bucketName", "key", "roleArn" ] }, "aws:iot/TopicRuleSns:TopicRuleSns": { "properties": { "messageFormat": { "type": "string", "description": "The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\".\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "targetArn": { "type": "string", "description": "The ARN of the SNS topic.\n" } }, "type": "object", "required": [ "roleArn", "targetArn" ] }, "aws:iot/TopicRuleSqs:TopicRuleSqs": { "properties": { "queueUrl": { "type": "string", "description": "The URL of the Amazon SQS queue.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access.\n" }, "useBase64": { "type": "boolean", "description": "Specifies whether to use Base64 encoding.\n" } }, "type": "object", "required": [ "queueUrl", "roleArn", "useBase64" ] }, "aws:iot/TopicRuleStepFunction:TopicRuleStepFunction": { "properties": { "executionNamePrefix": { "type": "string", "description": "The prefix used to generate, along with a UUID, the unique state machine execution name.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that grants access to start execution of the state machine.\n" }, "stateMachineName": { "type": "string", "description": "The name of the Step Functions state machine whose execution will be started.\n" } }, "type": "object", "required": [ "roleArn", "stateMachineName" ] }, "aws:iot/TopicRuleTimestream:TopicRuleTimestream": { "properties": { "databaseName": { "type": "string", "description": "The name of an Amazon Timestream database.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/aws:iot/TopicRuleTimestreamDimension:TopicRuleTimestreamDimension" }, "description": "Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.\n" }, "roleArn": { "type": "string", "description": "The ARN of the role that grants permission to write to the Amazon Timestream database table.\n" }, "tableName": { "type": "string", "description": "The name of the database table into which to write the measure records.\n" }, "timestamp": { "$ref": "#/types/aws:iot/TopicRuleTimestreamTimestamp:TopicRuleTimestreamTimestamp", "description": "Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.\n" } }, "type": "object", "required": [ "databaseName", "dimensions", "roleArn", "tableName" ] }, "aws:iot/TopicRuleTimestreamDimension:TopicRuleTimestreamDimension": { "properties": { "name": { "type": "string", "description": "The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.\n" }, "value": { "type": "string", "description": "The value to write in this column of the database record.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:iot/TopicRuleTimestreamTimestamp:TopicRuleTimestreamTimestamp": { "properties": { "unit": { "type": "string", "description": "The precision of the timestamp value that results from the expression described in value. Valid values: `SECONDS`, `MILLISECONDS`, `MICROSECONDS`, `NANOSECONDS`.\n" }, "value": { "type": "string", "description": "An expression that returns a long epoch time value.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "aws:ivs/RecordingConfigurationDestinationConfiguration:RecordingConfigurationDestinationConfiguration": { "properties": { "s3": { "$ref": "#/types/aws:ivs/RecordingConfigurationDestinationConfigurationS3:RecordingConfigurationDestinationConfigurationS3", "description": "S3 destination configuration where recorded videos will be stored.\n" } }, "type": "object", "required": [ "s3" ] }, "aws:ivs/RecordingConfigurationDestinationConfigurationS3:RecordingConfigurationDestinationConfigurationS3": { "properties": { "bucketName": { "type": "string", "description": "S3 bucket name where recorded videos will be stored.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "bucketName" ] }, "aws:ivs/RecordingConfigurationThumbnailConfiguration:RecordingConfigurationThumbnailConfiguration": { "properties": { "recordingMode": { "type": "string", "description": "Thumbnail recording mode. Valid values: `DISABLED`, `INTERVAL`.\n" }, "targetIntervalSeconds": { "type": "integer", "description": "The targeted thumbnail-generation interval in seconds.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "recordingMode", "targetIntervalSeconds" ] } } }, "aws:ivschat/LoggingConfigurationDestinationConfiguration:LoggingConfigurationDestinationConfiguration": { "properties": { "cloudwatchLogs": { "$ref": "#/types/aws:ivschat/LoggingConfigurationDestinationConfigurationCloudwatchLogs:LoggingConfigurationDestinationConfigurationCloudwatchLogs", "description": "An Amazon CloudWatch Logs destination configuration where chat activity will be logged.\n" }, "firehose": { "$ref": "#/types/aws:ivschat/LoggingConfigurationDestinationConfigurationFirehose:LoggingConfigurationDestinationConfigurationFirehose", "description": "An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.\n" }, "s3": { "$ref": "#/types/aws:ivschat/LoggingConfigurationDestinationConfigurationS3:LoggingConfigurationDestinationConfigurationS3", "description": "An Amazon S3 destination configuration where chat activity will be logged.\n" } }, "type": "object" }, "aws:ivschat/LoggingConfigurationDestinationConfigurationCloudwatchLogs:LoggingConfigurationDestinationConfigurationCloudwatchLogs": { "properties": { "logGroupName": { "type": "string", "description": "Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.\n" } }, "type": "object", "required": [ "logGroupName" ] }, "aws:ivschat/LoggingConfigurationDestinationConfigurationFirehose:LoggingConfigurationDestinationConfigurationFirehose": { "properties": { "deliveryStreamName": { "type": "string", "description": "Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.\n" } }, "type": "object", "required": [ "deliveryStreamName" ] }, "aws:ivschat/LoggingConfigurationDestinationConfigurationS3:LoggingConfigurationDestinationConfigurationS3": { "properties": { "bucketName": { "type": "string", "description": "Name of the Amazon S3 bucket where chat activity will be logged.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "bucketName" ] }, "aws:ivschat/RoomMessageReviewHandler:RoomMessageReviewHandler": { "properties": { "fallbackResult": { "type": "string", "description": "The fallback behavior (whether the message\nis allowed or denied) if the handler does not return a valid response,\nencounters an error, or times out. Valid values: `ALLOW`, `DENY`.\n" }, "uri": { "type": "string", "description": "ARN of the lambda message review handler function.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fallbackResult" ] } } }, "aws:kendra/DataSourceConfiguration:DataSourceConfiguration": { "properties": { "s3Configuration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationS3Configuration:DataSourceConfigurationS3Configuration", "description": "A block that provides the configuration information to connect to an Amazon S3 bucket as your data source. Detailed below.\n", "deprecationMessage": "s3_configuration is deprecated. Use template_configuration instead." }, "templateConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationTemplateConfiguration:DataSourceConfigurationTemplateConfiguration", "description": "A block that provides the configuration information required for Amazon Kendra Web Crawler. Detailed below.\n" }, "webCrawlerConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfiguration:DataSourceConfigurationWebCrawlerConfiguration", "description": "A block that provides the configuration information required for Amazon Kendra Web Crawler. Detailed below.\n", "deprecationMessage": "web_crawler_configuration is deprecated. Use template_configuration instead." } }, "type": "object" }, "aws:kendra/DataSourceConfigurationS3Configuration:DataSourceConfigurationS3Configuration": { "properties": { "accessControlListConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationS3ConfigurationAccessControlListConfiguration:DataSourceConfigurationS3ConfigurationAccessControlListConfiguration", "description": "A block that 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). Detailed below.\n" }, "bucketName": { "type": "string", "description": "The name of the bucket that contains the documents.\n" }, "documentsMetadataConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationS3ConfigurationDocumentsMetadataConfiguration:DataSourceConfigurationS3ConfigurationDocumentsMetadataConfiguration", "description": "A block that defines the 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. Detailed below.\n" }, "exclusionPatterns": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. Refer to [Exclusion Patterns for more examples](https://docs.aws.amazon.com/kendra/latest/dg/API_S3DataSourceConfiguration.html#Kendra-Type-S3DataSourceConfiguration-ExclusionPatterns).\n" }, "inclusionPatterns": { "type": "array", "items": { "type": "string" }, "description": "A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed. Refer to [Inclusion Patterns for more examples](https://docs.aws.amazon.com/kendra/latest/dg/API_S3DataSourceConfiguration.html#Kendra-Type-S3DataSourceConfiguration-InclusionPatterns).\n" }, "inclusionPrefixes": { "type": "array", "items": { "type": "string" }, "description": "A list of S3 prefixes for the documents that should be included in the index.\n" } }, "type": "object", "required": [ "bucketName" ] }, "aws:kendra/DataSourceConfigurationS3ConfigurationAccessControlListConfiguration:DataSourceConfigurationS3ConfigurationAccessControlListConfiguration": { "properties": { "keyPath": { "type": "string", "description": "Path to the AWS S3 bucket that contains the ACL files.\n" } }, "type": "object" }, "aws:kendra/DataSourceConfigurationS3ConfigurationDocumentsMetadataConfiguration:DataSourceConfigurationS3ConfigurationDocumentsMetadataConfiguration": { "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 `s3_prefix` to include only the desired metadata files.\n" } }, "type": "object" }, "aws:kendra/DataSourceConfigurationTemplateConfiguration:DataSourceConfigurationTemplateConfiguration": { "properties": { "template": { "type": "string", "description": "JSON string containing a [data source template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html).\n" } }, "type": "object", "required": [ "template" ] }, "aws:kendra/DataSourceConfigurationWebCrawlerConfiguration:DataSourceConfigurationWebCrawlerConfiguration": { "properties": { "authenticationConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfiguration:DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfiguration", "description": "A block with the configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials. You 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. Detailed below.\n" }, "crawlDepth": { "type": "integer", "description": "Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to `2`. Minimum value of `0`. Maximum value of `10`.\n" }, "maxContentSizePerPageInMegaBytes": { "type": "number", "description": "The maximum size (in MB) of a webpage or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a webpage or attachment is set to `50` MB. Minimum value of `1.0e-06`. Maximum value of `50`.\n" }, "maxLinksPerPage": { "type": "integer", "description": "The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage. As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance. The default maximum links per page is `100`. Minimum value of `1`. Maximum value of `1000`.\n" }, "maxUrlsPerMinuteCrawlRate": { "type": "integer", "description": "The maximum number of URLs crawled per website host per minute. The default maximum number of URLs crawled per website host per minute is `300`. Minimum value of `1`. Maximum value of `300`.\n" }, "proxyConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationProxyConfiguration:DataSourceConfigurationWebCrawlerConfigurationProxyConfiguration", "description": "Configuration information required to connect to your internal websites via a web proxy. You 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. Web 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). Detailed below.\n" }, "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. Array Members: Minimum number of `0` items. Maximum number of `100` items. Length Constraints: Minimum length of `1`. Maximum length of `150`.\n" }, "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. Array Members: Minimum number of `0` items. Maximum number of `100` items. Length Constraints: Minimum length of `1`. Maximum length of `150`.\n" }, "urls": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrls:DataSourceConfigurationWebCrawlerConfigurationUrls", "description": "A block that specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to `100` seed URLs and up to `3` sitemap URLs. You 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. When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://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. Detailed below.\n" } }, "type": "object", "required": [ "urls" ] }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfiguration:DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfiguration": { "properties": { "basicAuthentications": { "type": "array", "items": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfigurationBasicAuthentication:DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfigurationBasicAuthentication" }, "description": "The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host. Detailed below.\n" } }, "type": "object" }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfigurationBasicAuthentication:DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfigurationBasicAuthentication": { "properties": { "credentials": { "type": "string", "description": "Your secret ARN, which you can create in AWS Secrets Manager. You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.\n" }, "host": { "type": "string", "description": "The name of the website host you want to connect to using authentication credentials. For example, the host name of `https://a.example.com/page1.html` is `\"a.example.com\"`.\n" }, "port": { "type": "integer", "description": "The port number of the website host you want to connect to using authentication credentials. For example, the port for `https://a.example.com/page1.html` is `443`, the standard port for HTTPS.\n" } }, "type": "object", "required": [ "credentials", "host", "port" ] }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationProxyConfiguration:DataSourceConfigurationWebCrawlerConfigurationProxyConfiguration": { "properties": { "credentials": { "type": "string", "description": "Your secret ARN, which you can create in AWS Secrets Manager. The 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.\n" }, "host": { "type": "string", "description": "The name of the website host you want to connect to via a web proxy server. For example, the host name of `https://a.example.com/page1.html` is `\"a.example.com\"`.\n" }, "port": { "type": "integer", "description": "The port number of the website host you want to connect to via a web proxy server. For example, the port for `https://a.example.com/page1.html` is `443`, the standard port for HTTPS.\n" } }, "type": "object", "required": [ "host", "port" ] }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrls:DataSourceConfigurationWebCrawlerConfigurationUrls": { "properties": { "seedUrlConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrlsSeedUrlConfiguration:DataSourceConfigurationWebCrawlerConfigurationUrlsSeedUrlConfiguration", "description": "A block that specifies the configuration of the seed or starting point URLs of the websites you want to crawl. You 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 webpages link to. You can list up to `100` seed URLs. Detailed below.\n" }, "siteMapsConfiguration": { "$ref": "#/types/aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrlsSiteMapsConfiguration:DataSourceConfigurationWebCrawlerConfigurationUrlsSiteMapsConfiguration", "description": "A block that specifies the configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to `3` sitemap URLs. Detailed below.\n" } }, "type": "object" }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrlsSeedUrlConfiguration:DataSourceConfigurationWebCrawlerConfigurationUrlsSeedUrlConfiguration": { "properties": { "seedUrls": { "type": "array", "items": { "type": "string" }, "description": "The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of `100` seed URLs. Array Members: Minimum number of `0` items. Maximum number of `100` items. Length Constraints: Minimum length of `1`. Maximum length of `2048`.\n" }, "webCrawlerMode": { "type": "string", "description": "The default mode is set to `HOST_ONLY`. You can choose one of the following modes:\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 webpages link to.\n" } }, "type": "object", "required": [ "seedUrls" ] }, "aws:kendra/DataSourceConfigurationWebCrawlerConfigurationUrlsSiteMapsConfiguration:DataSourceConfigurationWebCrawlerConfigurationUrlsSiteMapsConfiguration": { "properties": { "siteMaps": { "type": "array", "items": { "type": "string" }, "description": "The list of sitemap URLs of the websites you want to crawl. The list can include a maximum of `3` sitemap URLs.\n" } }, "type": "object", "required": [ "siteMaps" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfiguration:DataSourceCustomDocumentEnrichmentConfiguration": { "properties": { "inlineConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfiguration:DataSourceCustomDocumentEnrichmentConfigurationInlineConfiguration" }, "description": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra. Minimum number of `0` items. Maximum number of `100` items. Detailed below.\n" }, "postExtractionHookConfiguration": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfiguration:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfiguration", "description": "A block that specifies the 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). Detailed below.\n" }, "preExtractionHookConfiguration": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfiguration:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfiguration", "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). Detailed below.\n" }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of a role with permission to run `pre_extraction_hook_configuration` and `post_extraction_hook_configuration` for altering document metadata and content during the document ingestion process. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).\n" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfiguration:DataSourceCustomDocumentEnrichmentConfigurationInlineConfiguration": { "properties": { "condition": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationCondition:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationCondition", "description": "Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. See condition.\n" }, "documentContentDeletion": { "type": "boolean", "description": "`TRUE` to delete content if the condition used for the target attribute is met.\n" }, "target": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTarget:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTarget", "description": "Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value. Detailed below.\n" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationCondition:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationCondition": { "properties": { "conditionDocumentAttributeKey": { "type": "string", "description": "The identifier of the document attribute used for the condition. For example, `_source_uri` could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Kendra currently does not support `_document_body` as an attribute key used for the condition.\n" }, "conditionOnValue": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationConditionConditionOnValue", "description": "The value used by the operator. For example, you can specify the value 'financial' for strings in the `_source_uri` field that partially match or contain this value. See condition_on_value.\n" }, "operator": { "type": "string", "description": "The condition operator. For example, you can use `Contains` to partially match a string. Valid Values: `GreaterThan` | `GreaterThanOrEquals` | `LessThan` | `LessThanOrEquals` | `Equals` | `NotEquals` | `Contains` | `NotContains` | `Exists` | `NotExists` | `BeginsWith`.\n" } }, "type": "object", "required": [ "conditionDocumentAttributeKey", "operator" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationConditionConditionOnValue": { "properties": { "dateValue": { "type": "string", "description": "A date expressed as an ISO 8601 string. It is important for the time zone to be included in the ISO 8601 date-time format. As of this writing only UTC is supported. For example, `2012-03-25T12:30:10+00:00`.\n" }, "longValue": { "type": "integer", "description": "A long integer value.\n" }, "stringListValues": { "type": "array", "items": { "type": "string" }, "description": "A list of strings.\n" }, "stringValue": { "type": "string" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTarget:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTarget": { "properties": { "targetDocumentAttributeKey": { "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.\n" }, "targetDocumentAttributeValue": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue", "description": "The target value you want to create for the target attribute. For example, 'Finance' could be the target value for the target attribute key 'Department'. See target_document_attribute_value.\n" }, "targetDocumentAttributeValueDeletion": { "type": "boolean", "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`. To create a target value (`TargetDocumentAttributeValue`), set this to `FALSE`.\n" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue:DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue": { "properties": { "dateValue": { "type": "string", "description": "A date expressed as an ISO 8601 string. It is important for the time zone to be included in the ISO 8601 date-time format. As of this writing only UTC is supported. For example, `2012-03-25T12:30:10+00:00`.\n" }, "longValue": { "type": "integer", "description": "A long integer value.\n" }, "stringListValues": { "type": "array", "items": { "type": "string" }, "description": "A list of strings.\n" }, "stringValue": { "type": "string" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfiguration:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfiguration": { "properties": { "invocationCondition": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationCondition:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationCondition", "description": "A block that specifies the condition used for when a Lambda function should be invoked. For 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. See invocation_condition.\n" }, "lambdaArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of a Lambda Function that can manipulate your document metadata fields or attributes and content.\n" }, "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).\n" } }, "type": "object", "required": [ "lambdaArn", "s3Bucket" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationCondition:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationCondition": { "properties": { "conditionDocumentAttributeKey": { "type": "string", "description": "The identifier of the document attribute used for the condition. For example, `_source_uri` could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Kendra currently does not support `_document_body` as an attribute key used for the condition.\n" }, "conditionOnValue": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationConditionConditionOnValue", "description": "The value used by the operator. For example, you can specify the value 'financial' for strings in the `_source_uri` field that partially match or contain this value. See condition_on_value.\n" }, "operator": { "type": "string", "description": "The condition operator. For example, you can use `Contains` to partially match a string. Valid Values: `GreaterThan` | `GreaterThanOrEquals` | `LessThan` | `LessThanOrEquals` | `Equals` | `NotEquals` | `Contains` | `NotContains` | `Exists` | `NotExists` | `BeginsWith`.\n" } }, "type": "object", "required": [ "conditionDocumentAttributeKey", "operator" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationPostExtractionHookConfigurationInvocationConditionConditionOnValue": { "properties": { "dateValue": { "type": "string", "description": "A date expressed as an ISO 8601 string. It is important for the time zone to be included in the ISO 8601 date-time format. As of this writing only UTC is supported. For example, `2012-03-25T12:30:10+00:00`.\n" }, "longValue": { "type": "integer", "description": "A long integer value.\n" }, "stringListValues": { "type": "array", "items": { "type": "string" }, "description": "A list of strings.\n" }, "stringValue": { "type": "string" } }, "type": "object" }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfiguration:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfiguration": { "properties": { "invocationCondition": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationCondition:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationCondition", "description": "A block that specifies the condition used for when a Lambda function should be invoked. For 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. See invocation_condition.\n" }, "lambdaArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of a Lambda Function that can manipulate your document metadata fields or attributes and content.\n" }, "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).\n" } }, "type": "object", "required": [ "lambdaArn", "s3Bucket" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationCondition:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationCondition": { "properties": { "conditionDocumentAttributeKey": { "type": "string", "description": "The identifier of the document attribute used for the condition. For example, `_source_uri` could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Kendra currently does not support `_document_body` as an attribute key used for the condition.\n" }, "conditionOnValue": { "$ref": "#/types/aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationConditionConditionOnValue", "description": "The value used by the operator. For example, you can specify the value 'financial' for strings in the `_source_uri` field that partially match or contain this value. See condition_on_value.\n" }, "operator": { "type": "string", "description": "The condition operator. For example, you can use `Contains` to partially match a string. Valid Values: `GreaterThan` | `GreaterThanOrEquals` | `LessThan` | `LessThanOrEquals` | `Equals` | `NotEquals` | `Contains` | `NotContains` | `Exists` | `NotExists` | `BeginsWith`.\n" } }, "type": "object", "required": [ "conditionDocumentAttributeKey", "operator" ] }, "aws:kendra/DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationConditionConditionOnValue:DataSourceCustomDocumentEnrichmentConfigurationPreExtractionHookConfigurationInvocationConditionConditionOnValue": { "properties": { "dateValue": { "type": "string", "description": "A date expressed as an ISO 8601 string. It is important for the time zone to be included in the ISO 8601 date-time format. As of this writing only UTC is supported. For example, `2012-03-25T12:30:10+00:00`.\n" }, "longValue": { "type": "integer", "description": "A long integer value.\n" }, "stringListValues": { "type": "array", "items": { "type": "string" }, "description": "A list of strings.\n" }, "stringValue": { "type": "string" } }, "type": "object" }, "aws:kendra/ExperienceConfiguration:ExperienceConfiguration": { "properties": { "contentSourceConfiguration": { "$ref": "#/types/aws:kendra/ExperienceConfigurationContentSourceConfiguration:ExperienceConfigurationContentSourceConfiguration", "description": "The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the `BatchPutDocument API`. The provider will only perform drift detection of its value when present in a configuration. Detailed below.\n" }, "userIdentityConfiguration": { "$ref": "#/types/aws:kendra/ExperienceConfigurationUserIdentityConfiguration:ExperienceConfigurationUserIdentityConfiguration", "description": "The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "contentSourceConfiguration" ] } } }, "aws:kendra/ExperienceConfigurationContentSourceConfiguration:ExperienceConfigurationContentSourceConfiguration": { "properties": { "dataSourceIds": { "type": "array", "items": { "type": "string" }, "description": "The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.\n" }, "directPutContent": { "type": "boolean", "description": "Whether to use documents you indexed directly using the `BatchPutDocument API`. Defaults to `false`.\n" }, "faqIds": { "type": "array", "items": { "type": "string" }, "description": "The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.\n" } }, "type": "object" }, "aws:kendra/ExperienceConfigurationUserIdentityConfiguration:ExperienceConfigurationUserIdentityConfiguration": { "properties": { "identityAttributeName": { "type": "string", "description": "The AWS SSO field name that contains the identifiers of your users, such as their emails.\n" } }, "type": "object", "required": [ "identityAttributeName" ] }, "aws:kendra/ExperienceEndpoint:ExperienceEndpoint": { "properties": { "endpoint": { "type": "string", "description": "The endpoint of your Amazon Kendra experience.\n" }, "endpointType": { "type": "string", "description": "The type of endpoint for your Amazon Kendra experience.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpoint", "endpointType" ] } } }, "aws:kendra/FaqS3Path:FaqS3Path": { "properties": { "bucket": { "type": "string", "description": "The name of the S3 bucket that contains the file.\n", "willReplaceOnChanges": true }, "key": { "type": "string", "description": "The name of the file.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "key" ] }, "aws:kendra/IndexCapacityUnits:IndexCapacityUnits": { "properties": { "queryCapacityUnits": { "type": "integer", "description": "The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to [QueryCapacityUnits](https://docs.aws.amazon.com/kendra/latest/dg/API_CapacityUnitsConfiguration.html#Kendra-Type-CapacityUnitsConfiguration-QueryCapacityUnits).\n" }, "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. Minimum value of 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "queryCapacityUnits", "storageCapacityUnits" ] } } }, "aws:kendra/IndexDocumentMetadataConfigurationUpdate:IndexDocumentMetadataConfigurationUpdate": { "properties": { "name": { "type": "string", "description": "The name of the index field. Minimum length of 1. Maximum length of 30.\n" }, "relevance": { "$ref": "#/types/aws:kendra/IndexDocumentMetadataConfigurationUpdateRelevance:IndexDocumentMetadataConfigurationUpdateRelevance", "description": "A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below\n" }, "search": { "$ref": "#/types/aws:kendra/IndexDocumentMetadataConfigurationUpdateSearch:IndexDocumentMetadataConfigurationUpdateSearch", "description": "A block that provides information about how the field is used during a search. Documented below. Detailed below\n" }, "type": { "type": "string", "description": "The data type of the index field. Valid values are `STRING_VALUE`, `STRING_LIST_VALUE`, `LONG_VALUE`, `DATE_VALUE`.\n" } }, "type": "object", "required": [ "name", "type" ], "language": { "nodejs": { "requiredOutputs": [ "name", "relevance", "search", "type" ] } } }, "aws:kendra/IndexDocumentMetadataConfigurationUpdateRelevance:IndexDocumentMetadataConfigurationUpdateRelevance": { "properties": { "duration": { "type": "string", "description": "Specifies the time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Duration).\n" }, "freshness": { "type": "boolean", "description": "Indicates that this field determines how \"fresh\" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Freshness).\n" }, "importance": { "type": "integer", "description": "The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.\n" }, "rankOrder": { "type": "string", "description": "Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-RankOrder).\n" }, "valuesImportanceMap": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "duration", "freshness", "importance", "rankOrder", "valuesImportanceMap" ] } } }, "aws:kendra/IndexDocumentMetadataConfigurationUpdateSearch:IndexDocumentMetadataConfigurationUpdateSearch": { "properties": { "displayable": { "type": "boolean", "description": "Determines whether the field is returned in the query response. The default is `true`.\n" }, "facetable": { "type": "boolean", "description": "Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false`.\n" }, "searchable": { "type": "boolean", "description": "Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for `string` fields and `false` for `number` and `date` fields.\n" }, "sortable": { "type": "boolean", "description": "Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is `false`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayable", "facetable", "searchable", "sortable" ] } } }, "aws:kendra/IndexIndexStatistic:IndexIndexStatistic": { "properties": { "faqStatistics": { "type": "array", "items": { "$ref": "#/types/aws:kendra/IndexIndexStatisticFaqStatistic:IndexIndexStatisticFaqStatistic" }, "description": "A block that specifies the number of question and answer topics in the index. Detailed below.\n" }, "textDocumentStatistics": { "type": "array", "items": { "$ref": "#/types/aws:kendra/IndexIndexStatisticTextDocumentStatistic:IndexIndexStatisticTextDocumentStatistic" }, "description": "A block that specifies the number of text documents indexed. Detailed below.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "faqStatistics", "textDocumentStatistics" ] } } }, "aws:kendra/IndexIndexStatisticFaqStatistic:IndexIndexStatisticFaqStatistic": { "properties": { "indexedQuestionAnswersCount": { "type": "integer", "description": "The total number of FAQ questions and answers contained in the index.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "indexedQuestionAnswersCount" ] } } }, "aws:kendra/IndexIndexStatisticTextDocumentStatistic:IndexIndexStatisticTextDocumentStatistic": { "properties": { "indexedTextBytes": { "type": "integer", "description": "The total size, in bytes, of the indexed documents.\n" }, "indexedTextDocumentsCount": { "type": "integer", "description": "The number of text documents indexed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "indexedTextBytes", "indexedTextDocumentsCount" ] } } }, "aws:kendra/IndexServerSideEncryptionConfiguration:IndexServerSideEncryptionConfiguration": { "properties": { "kmsKeyId": { "type": "string", "description": "The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:kendra/IndexUserGroupResolutionConfiguration:IndexUserGroupResolutionConfiguration": { "properties": { "userGroupResolutionMode": { "type": "string", "description": "The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are `AWS_SSO` or `NONE`.\n" } }, "type": "object", "required": [ "userGroupResolutionMode" ] }, "aws:kendra/IndexUserTokenConfigurations:IndexUserTokenConfigurations": { "properties": { "jsonTokenTypeConfiguration": { "$ref": "#/types/aws:kendra/IndexUserTokenConfigurationsJsonTokenTypeConfiguration:IndexUserTokenConfigurationsJsonTokenTypeConfiguration", "description": "A block that specifies the information about the JSON token type configuration. Detailed below.\n" }, "jwtTokenTypeConfiguration": { "$ref": "#/types/aws:kendra/IndexUserTokenConfigurationsJwtTokenTypeConfiguration:IndexUserTokenConfigurationsJwtTokenTypeConfiguration", "description": "A block that specifies the information about the JWT token type configuration. Detailed below.\n" } }, "type": "object" }, "aws:kendra/IndexUserTokenConfigurationsJsonTokenTypeConfiguration:IndexUserTokenConfigurationsJsonTokenTypeConfiguration": { "properties": { "groupAttributeField": { "type": "string", "description": "The group attribute field. Minimum length of 1. Maximum length of 2048.\n" }, "userNameAttributeField": { "type": "string", "description": "The user name attribute field. Minimum length of 1. Maximum length of 2048.\n" } }, "type": "object", "required": [ "groupAttributeField", "userNameAttributeField" ] }, "aws:kendra/IndexUserTokenConfigurationsJwtTokenTypeConfiguration:IndexUserTokenConfigurationsJwtTokenTypeConfiguration": { "properties": { "claimRegex": { "type": "string", "description": "The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.\n" }, "groupAttributeField": { "type": "string", "description": "The group attribute field. Minimum length of 1. Maximum length of 100.\n" }, "issuer": { "type": "string", "description": "The issuer of the token. Minimum length of 1. Maximum length of 65.\n" }, "keyLocation": { "type": "string", "description": "The location of the key. Valid values are `URL` or `SECRET_MANAGER`\n" }, "secretsManagerArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the secret.\n" }, "url": { "type": "string", "description": "The signing key URL. Valid pattern is `^(https?|ftp|file):\\/\\/([^\\s]*)`\n" }, "userNameAttributeField": { "type": "string", "description": "The user name attribute field. Minimum length of 1. Maximum length of 100.\n" } }, "type": "object", "required": [ "keyLocation" ] }, "aws:kendra/QuerySuggestionsBlockListSourceS3Path:QuerySuggestionsBlockListSourceS3Path": { "properties": { "bucket": { "type": "string", "description": "Name of the S3 bucket that contains the file.\n" }, "key": { "type": "string", "description": "Name of the file.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "bucket", "key" ] }, "aws:kendra/ThesaurusSourceS3Path:ThesaurusSourceS3Path": { "properties": { "bucket": { "type": "string", "description": "The name of the S3 bucket that contains the file.\n" }, "key": { "type": "string", "description": "The name of the file.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "bucket", "key" ] }, "aws:kendra/getExperienceConfiguration:getExperienceConfiguration": { "properties": { "contentSourceConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getExperienceConfigurationContentSourceConfiguration:getExperienceConfigurationContentSourceConfiguration" }, "description": "The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.\n" }, "userIdentityConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getExperienceConfigurationUserIdentityConfiguration:getExperienceConfigurationUserIdentityConfiguration" }, "description": "The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.\n" } }, "type": "object", "required": [ "contentSourceConfigurations", "userIdentityConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getExperienceConfigurationContentSourceConfiguration:getExperienceConfigurationContentSourceConfiguration": { "properties": { "dataSourceIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the data sources you want to use for your Amazon Kendra Experience.\n" }, "directPutContent": { "type": "boolean", "description": "Whether to use documents you indexed directly using the `BatchPutDocument API`.\n" }, "faqIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of the FAQs that you want to use for your Amazon Kendra Experience.\n" } }, "type": "object", "required": [ "dataSourceIds", "directPutContent", "faqIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getExperienceConfigurationUserIdentityConfiguration:getExperienceConfigurationUserIdentityConfiguration": { "properties": { "identityAttributeName": { "type": "string", "description": "The AWS SSO field name that contains the identifiers of your users, such as their emails.\n" } }, "type": "object", "required": [ "identityAttributeName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getExperienceEndpoint:getExperienceEndpoint": { "properties": { "endpoint": { "type": "string", "description": "Endpoint of your Amazon Kendra Experience.\n" }, "endpointType": { "type": "string", "description": "Type of endpoint for your Amazon Kendra Experience.\n" } }, "type": "object", "required": [ "endpoint", "endpointType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getFaqS3Path:getFaqS3Path": { "properties": { "bucket": { "type": "string", "description": "Name of the S3 bucket that contains the file.\n" }, "key": { "type": "string", "description": "Name of the file.\n" } }, "type": "object", "required": [ "bucket", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexCapacityUnit:getIndexCapacityUnit": { "properties": { "queryCapacityUnits": { "type": "integer", "description": "The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to [QueryCapacityUnits](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html#Kendra-Type-CapacityUnitsConfiguration-QueryCapacityUnits).\n" }, "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. Minimum value of 0.\n" } }, "type": "object", "required": [ "queryCapacityUnits", "storageCapacityUnits" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexDocumentMetadataConfigurationUpdate:getIndexDocumentMetadataConfigurationUpdate": { "properties": { "name": { "type": "string", "description": "Name of the index field. Minimum length of 1. Maximum length of 30.\n" }, "relevances": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexDocumentMetadataConfigurationUpdateRelevance:getIndexDocumentMetadataConfigurationUpdateRelevance" }, "description": "Block that provides manual tuning parameters to determine how the field affects the search results. Documented below.\n" }, "searches": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexDocumentMetadataConfigurationUpdateSearch:getIndexDocumentMetadataConfigurationUpdateSearch" }, "description": "Block that provides information about how the field is used during a search. Documented below.\n" }, "type": { "type": "string", "description": "Data type of the index field. Valid values are `STRING_VALUE`, `STRING_LIST_VALUE`, `LONG_VALUE`, `DATE_VALUE`.\n" } }, "type": "object", "required": [ "name", "relevances", "searches", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexDocumentMetadataConfigurationUpdateRelevance:getIndexDocumentMetadataConfigurationUpdateRelevance": { "properties": { "duration": { "type": "string", "description": "Time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Relevance.html#Kendra-Type-Relevance-Duration).\n" }, "freshness": { "type": "boolean", "description": "How \"fresh\" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Relevance.html#Kendra-Type-Relevance-Freshness).\n" }, "importance": { "type": "integer", "description": "Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.\n" }, "rankOrder": { "type": "string", "description": "Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Relevance.html#Kendra-Type-Relevance-RankOrder).\n" }, "valuesImportanceMap": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).\n" } }, "type": "object", "required": [ "duration", "freshness", "importance", "rankOrder", "valuesImportanceMap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexDocumentMetadataConfigurationUpdateSearch:getIndexDocumentMetadataConfigurationUpdateSearch": { "properties": { "displayable": { "type": "boolean", "description": "Determines whether the field is returned in the query response. The default is `true`.\n" }, "facetable": { "type": "boolean", "description": "Whether the field can be used to create search facets, a count of results for each value in the field. The default is `false`.\n" }, "searchable": { "type": "boolean", "description": "Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for `string` fields and `false` for `number` and `date` fields.\n" }, "sortable": { "type": "boolean", "description": "Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is `false`.\n" } }, "type": "object", "required": [ "displayable", "facetable", "searchable", "sortable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexIndexStatistic:getIndexIndexStatistic": { "properties": { "faqStatistics": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexIndexStatisticFaqStatistic:getIndexIndexStatisticFaqStatistic" }, "description": "Block that specifies the number of question and answer topics in the index. Documented below.\n" }, "textDocumentStatistics": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexIndexStatisticTextDocumentStatistic:getIndexIndexStatisticTextDocumentStatistic" }, "description": "A block that specifies the number of text documents indexed.\n" } }, "type": "object", "required": [ "faqStatistics", "textDocumentStatistics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexIndexStatisticFaqStatistic:getIndexIndexStatisticFaqStatistic": { "properties": { "indexedQuestionAnswersCount": { "type": "integer", "description": "The total number of FAQ questions and answers contained in the index.\n" } }, "type": "object", "required": [ "indexedQuestionAnswersCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexIndexStatisticTextDocumentStatistic:getIndexIndexStatisticTextDocumentStatistic": { "properties": { "indexedTextBytes": { "type": "integer", "description": "Total size, in bytes, of the indexed documents.\n" }, "indexedTextDocumentsCount": { "type": "integer", "description": "The number of text documents indexed.\n" } }, "type": "object", "required": [ "indexedTextBytes", "indexedTextDocumentsCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexServerSideEncryptionConfiguration:getIndexServerSideEncryptionConfiguration": { "properties": { "kmsKeyId": { "type": "string", "description": "Identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.\n" } }, "type": "object", "required": [ "kmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexUserGroupResolutionConfiguration:getIndexUserGroupResolutionConfiguration": { "properties": { "userGroupResolutionMode": { "type": "string", "description": "The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are `AWS_SSO` or `NONE`.\n" } }, "type": "object", "required": [ "userGroupResolutionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexUserTokenConfiguration:getIndexUserTokenConfiguration": { "properties": { "jsonTokenTypeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexUserTokenConfigurationJsonTokenTypeConfiguration:getIndexUserTokenConfigurationJsonTokenTypeConfiguration" }, "description": "A block that specifies the information about the JSON token type configuration.\n" }, "jwtTokenTypeConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kendra/getIndexUserTokenConfigurationJwtTokenTypeConfiguration:getIndexUserTokenConfigurationJwtTokenTypeConfiguration" }, "description": "A block that specifies the information about the JWT token type configuration.\n" } }, "type": "object", "required": [ "jsonTokenTypeConfigurations", "jwtTokenTypeConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexUserTokenConfigurationJsonTokenTypeConfiguration:getIndexUserTokenConfigurationJsonTokenTypeConfiguration": { "properties": { "groupAttributeField": { "type": "string", "description": "The group attribute field.\n" }, "userNameAttributeField": { "type": "string", "description": "The user name attribute field.\n" } }, "type": "object", "required": [ "groupAttributeField", "userNameAttributeField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getIndexUserTokenConfigurationJwtTokenTypeConfiguration:getIndexUserTokenConfigurationJwtTokenTypeConfiguration": { "properties": { "claimRegex": { "type": "string", "description": "Regular expression that identifies the claim.\n" }, "groupAttributeField": { "type": "string", "description": "The group attribute field.\n" }, "issuer": { "type": "string", "description": "Issuer of the token.\n" }, "keyLocation": { "type": "string", "description": "Location of the key. Valid values are `URL` or `SECRET_MANAGER`\n" }, "secretsManagerArn": { "type": "string", "description": "ARN of the secret.\n" }, "url": { "type": "string", "description": "Signing key URL.\n" }, "userNameAttributeField": { "type": "string", "description": "The user name attribute field.\n" } }, "type": "object", "required": [ "claimRegex", "groupAttributeField", "issuer", "keyLocation", "secretsManagerArn", "url", "userNameAttributeField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getQuerySuggestionsBlockListSourceS3Path:getQuerySuggestionsBlockListSourceS3Path": { "properties": { "bucket": { "type": "string", "description": "Name of the S3 bucket that contains the file.\n" }, "key": { "type": "string", "description": "Name of the file.\n" } }, "type": "object", "required": [ "bucket", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kendra/getThesaurusSourceS3Path:getThesaurusSourceS3Path": { "properties": { "bucket": { "type": "string", "description": "Name of the S3 bucket that contains the file.\n" }, "key": { "type": "string", "description": "Name of the file.\n" } }, "type": "object", "required": [ "bucket", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:keyspaces/KeyspaceReplicationSpecification:KeyspaceReplicationSpecification": { "properties": { "regionLists": { "type": "array", "items": { "type": "string" }, "description": "Replication regions. If `replication_strategy` is `MULTI_REGION`, `region_list` requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.\n", "willReplaceOnChanges": true }, "replicationStrategy": { "type": "string", "description": "Replication strategy. Valid values: `SINGLE_REGION` and `MULTI_REGION`.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "replicationStrategy" ] } } }, "aws:keyspaces/TableCapacitySpecification:TableCapacitySpecification": { "properties": { "readCapacityUnits": { "type": "integer", "description": "The throughput capacity specified for read operations defined in read capacity units (RCUs).\n" }, "throughputMode": { "type": "string", "description": "The read/write throughput capacity mode for a table. Valid values: `PAY_PER_REQUEST`, `PROVISIONED`. The default value is `PAY_PER_REQUEST`.\n" }, "writeCapacityUnits": { "type": "integer", "description": "The throughput capacity specified for write operations defined in write capacity units (WCUs).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "throughputMode" ] } } }, "aws:keyspaces/TableClientSideTimestamps:TableClientSideTimestamps": { "properties": { "status": { "type": "string", "description": "Shows how to enable client-side timestamps settings for the specified table. Valid values: `ENABLED`.\n" } }, "type": "object", "required": [ "status" ] }, "aws:keyspaces/TableComment:TableComment": { "properties": { "message": { "type": "string", "description": "A description of the table.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message" ] } } }, "aws:keyspaces/TableEncryptionSpecification:TableEncryptionSpecification": { "properties": { "kmsKeyIdentifier": { "type": "string", "description": "The Amazon Resource Name (ARN) of the customer managed KMS key.\n" }, "type": { "type": "string", "description": "The encryption option specified for the table. Valid values: `AWS_OWNED_KMS_KEY`, `CUSTOMER_MANAGED_KMS_KEY`. The default value is `AWS_OWNED_KMS_KEY`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "aws:keyspaces/TablePointInTimeRecovery:TablePointInTimeRecovery": { "properties": { "status": { "type": "string", "description": "Valid values: `ENABLED`, `DISABLED`. The default value is `DISABLED`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "status" ] } } }, "aws:keyspaces/TableSchemaDefinition:TableSchemaDefinition": { "properties": { "clusteringKeys": { "type": "array", "items": { "$ref": "#/types/aws:keyspaces/TableSchemaDefinitionClusteringKey:TableSchemaDefinitionClusteringKey" }, "description": "The columns that are part of the clustering key of the table.\n", "willReplaceOnChanges": true }, "columns": { "type": "array", "items": { "$ref": "#/types/aws:keyspaces/TableSchemaDefinitionColumn:TableSchemaDefinitionColumn" }, "description": "The regular columns of the table.\n" }, "partitionKeys": { "type": "array", "items": { "$ref": "#/types/aws:keyspaces/TableSchemaDefinitionPartitionKey:TableSchemaDefinitionPartitionKey" }, "description": "The columns that are part of the partition key of the table .\n", "willReplaceOnChanges": true }, "staticColumns": { "type": "array", "items": { "$ref": "#/types/aws:keyspaces/TableSchemaDefinitionStaticColumn:TableSchemaDefinitionStaticColumn" }, "description": "The columns that have been defined as `STATIC`. Static columns store values that are shared by all rows in the same partition.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "columns", "partitionKeys" ] }, "aws:keyspaces/TableSchemaDefinitionClusteringKey:TableSchemaDefinitionClusteringKey": { "properties": { "name": { "type": "string", "description": "The name of the clustering key column.\n", "willReplaceOnChanges": true }, "orderBy": { "type": "string", "description": "The order modifier. Valid values: `ASC`, `DESC`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "orderBy" ] }, "aws:keyspaces/TableSchemaDefinitionColumn:TableSchemaDefinitionColumn": { "properties": { "name": { "type": "string", "description": "The name of the column.\n" }, "type": { "type": "string", "description": "The data type of the column. See the [Developer Guide](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) for a list of available data types.\n" } }, "type": "object", "required": [ "name", "type" ] }, "aws:keyspaces/TableSchemaDefinitionPartitionKey:TableSchemaDefinitionPartitionKey": { "properties": { "name": { "type": "string", "description": "The name of the partition key column.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ] }, "aws:keyspaces/TableSchemaDefinitionStaticColumn:TableSchemaDefinitionStaticColumn": { "properties": { "name": { "type": "string", "description": "The name of the static column.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ] }, "aws:keyspaces/TableTtl:TableTtl": { "properties": { "status": { "type": "string", "description": "Valid values: `ENABLED`.\n" } }, "type": "object", "required": [ "status" ] }, "aws:kinesis/AnalyticsApplicationCloudwatchLoggingOptions:AnalyticsApplicationCloudwatchLoggingOptions": { "properties": { "id": { "type": "string", "description": "The ARN of the Kinesis Analytics Application.\n" }, "logStreamArn": { "type": "string", "description": "The ARN of the CloudWatch Log Stream.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to send application messages.\n" } }, "type": "object", "required": [ "logStreamArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "id", "logStreamArn", "roleArn" ] } } }, "aws:kinesis/AnalyticsApplicationInputs:AnalyticsApplicationInputs": { "properties": { "id": { "type": "string", "description": "The ARN of the Kinesis Analytics Application.\n" }, "kinesisFirehose": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsKinesisFirehose:AnalyticsApplicationInputsKinesisFirehose", "description": "The Kinesis Firehose configuration for the streaming source. Conflicts with `kinesis_stream`.\nSee Kinesis Firehose below for more details.\n" }, "kinesisStream": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsKinesisStream:AnalyticsApplicationInputsKinesisStream", "description": "The Kinesis Stream configuration for the streaming source. Conflicts with `kinesis_firehose`.\nSee Kinesis Stream below for more details.\n" }, "namePrefix": { "type": "string", "description": "The Name Prefix to use when creating an in-application stream.\n" }, "parallelism": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsParallelism:AnalyticsApplicationInputsParallelism", "description": "The number of Parallel in-application streams to create.\nSee Parallelism below for more details.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsProcessingConfiguration:AnalyticsApplicationInputsProcessingConfiguration", "description": "The Processing Configuration to transform records as they are received from the stream.\nSee Processing Configuration below for more details.\n" }, "schema": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchema:AnalyticsApplicationInputsSchema", "description": "The Schema format of the data in the streaming source. See Source Schema below for more details.\n" }, "startingPositionConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsStartingPositionConfiguration:AnalyticsApplicationInputsStartingPositionConfiguration" }, "description": "The point at which the application starts processing records from the streaming source.\nSee Starting Position Configuration below for more details.\n" }, "streamNames": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "namePrefix", "schema" ], "language": { "nodejs": { "requiredOutputs": [ "id", "namePrefix", "parallelism", "schema", "startingPositionConfigurations", "streamNames" ] } } }, "aws:kinesis/AnalyticsApplicationInputsKinesisFirehose:AnalyticsApplicationInputsKinesisFirehose": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Kinesis Firehose delivery stream.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the stream.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationInputsKinesisStream:AnalyticsApplicationInputsKinesisStream": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Kinesis Stream.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the stream.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationInputsParallelism:AnalyticsApplicationInputsParallelism": { "properties": { "count": { "type": "integer", "description": "The Count of streams.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "count" ] } } }, "aws:kinesis/AnalyticsApplicationInputsProcessingConfiguration:AnalyticsApplicationInputsProcessingConfiguration": { "properties": { "lambda": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsProcessingConfigurationLambda:AnalyticsApplicationInputsProcessingConfigurationLambda", "description": "The Lambda function configuration. See Lambda below for more details.\n" } }, "type": "object", "required": [ "lambda" ] }, "aws:kinesis/AnalyticsApplicationInputsProcessingConfigurationLambda:AnalyticsApplicationInputsProcessingConfigurationLambda": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Lambda function.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the Lambda function.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationInputsSchema:AnalyticsApplicationInputsSchema": { "properties": { "recordColumns": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchemaRecordColumn:AnalyticsApplicationInputsSchemaRecordColumn" }, "description": "The Record Column mapping for the streaming source data element.\nSee Record Columns below for more details.\n" }, "recordEncoding": { "type": "string", "description": "The Encoding of the record in the streaming source.\n" }, "recordFormat": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormat:AnalyticsApplicationInputsSchemaRecordFormat", "description": "The Record Format and mapping information to schematize a record.\nSee Record Format below for more details.\n" } }, "type": "object", "required": [ "recordColumns", "recordFormat" ] }, "aws:kinesis/AnalyticsApplicationInputsSchemaRecordColumn:AnalyticsApplicationInputsSchemaRecordColumn": { "properties": { "mapping": { "type": "string", "description": "The Mapping reference to the data element.\n" }, "name": { "type": "string", "description": "Name of the column.\n" }, "sqlType": { "type": "string", "description": "The SQL Type of the column.\n" } }, "type": "object", "required": [ "name", "sqlType" ] }, "aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormat:AnalyticsApplicationInputsSchemaRecordFormat": { "properties": { "mappingParameters": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParameters:AnalyticsApplicationInputsSchemaRecordFormatMappingParameters", "description": "The Mapping Information for the record format.\nSee Mapping Parameters below for more details.\n" }, "recordFormatType": { "type": "string", "description": "The type of Record Format. Can be `CSV` or `JSON`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "recordFormatType" ] } } }, "aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParameters:AnalyticsApplicationInputsSchemaRecordFormatMappingParameters": { "properties": { "csv": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParametersCsv:AnalyticsApplicationInputsSchemaRecordFormatMappingParametersCsv", "description": "Mapping information when the record format uses delimiters.\nSee CSV Mapping Parameters below for more details.\n" }, "json": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParametersJson:AnalyticsApplicationInputsSchemaRecordFormatMappingParametersJson", "description": "Mapping information when JSON is the record format on the streaming source.\nSee JSON Mapping Parameters below for more details.\n" } }, "type": "object" }, "aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParametersCsv:AnalyticsApplicationInputsSchemaRecordFormatMappingParametersCsv": { "properties": { "recordColumnDelimiter": { "type": "string", "description": "The Column Delimiter.\n" }, "recordRowDelimiter": { "type": "string", "description": "The Row Delimiter.\n" } }, "type": "object", "required": [ "recordColumnDelimiter", "recordRowDelimiter" ] }, "aws:kinesis/AnalyticsApplicationInputsSchemaRecordFormatMappingParametersJson:AnalyticsApplicationInputsSchemaRecordFormatMappingParametersJson": { "properties": { "recordRowPath": { "type": "string", "description": "Path to the top-level parent that contains the records.\n" } }, "type": "object", "required": [ "recordRowPath" ] }, "aws:kinesis/AnalyticsApplicationInputsStartingPositionConfiguration:AnalyticsApplicationInputsStartingPositionConfiguration": { "properties": { "startingPosition": { "type": "string", "description": "The starting position on the stream. Valid values: `LAST_STOPPED_POINT`, `NOW`, `TRIM_HORIZON`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "startingPosition" ] } } }, "aws:kinesis/AnalyticsApplicationOutput:AnalyticsApplicationOutput": { "properties": { "id": { "type": "string", "description": "The ARN of the Kinesis Analytics Application.\n" }, "kinesisFirehose": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationOutputKinesisFirehose:AnalyticsApplicationOutputKinesisFirehose", "description": "The Kinesis Firehose configuration for the destination stream. Conflicts with `kinesis_stream`.\nSee Kinesis Firehose below for more details.\n" }, "kinesisStream": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationOutputKinesisStream:AnalyticsApplicationOutputKinesisStream", "description": "The Kinesis Stream configuration for the destination stream. Conflicts with `kinesis_firehose`.\nSee Kinesis Stream below for more details.\n" }, "lambda": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationOutputLambda:AnalyticsApplicationOutputLambda", "description": "The Lambda function destination. See Lambda below for more details.\n" }, "name": { "type": "string", "description": "The Name of the in-application stream.\n" }, "schema": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationOutputSchema:AnalyticsApplicationOutputSchema", "description": "The Schema format of the data written to the destination. See Destination Schema below for more details.\n" } }, "type": "object", "required": [ "name", "schema" ], "language": { "nodejs": { "requiredOutputs": [ "id", "name", "schema" ] } } }, "aws:kinesis/AnalyticsApplicationOutputKinesisFirehose:AnalyticsApplicationOutputKinesisFirehose": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Kinesis Firehose delivery stream.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the stream.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationOutputKinesisStream:AnalyticsApplicationOutputKinesisStream": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Kinesis Stream.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the stream.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationOutputLambda:AnalyticsApplicationOutputLambda": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Lambda function.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM Role used to access the Lambda function.\n" } }, "type": "object", "required": [ "resourceArn", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationOutputSchema:AnalyticsApplicationOutputSchema": { "properties": { "recordFormatType": { "type": "string", "description": "The Format Type of the records on the output stream. Can be `CSV` or `JSON`.\n" } }, "type": "object", "required": [ "recordFormatType" ] }, "aws:kinesis/AnalyticsApplicationReferenceDataSources:AnalyticsApplicationReferenceDataSources": { "properties": { "id": { "type": "string", "description": "The ARN of the Kinesis Analytics Application.\n" }, "s3": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesS3:AnalyticsApplicationReferenceDataSourcesS3", "description": "The S3 configuration for the reference data source. See S3 Reference below for more details.\n" }, "schema": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchema:AnalyticsApplicationReferenceDataSourcesSchema", "description": "The Schema format of the data in the streaming source. See Source Schema below for more details.\n" }, "tableName": { "type": "string", "description": "The in-application Table Name.\n" } }, "type": "object", "required": [ "s3", "schema", "tableName" ], "language": { "nodejs": { "requiredOutputs": [ "id", "s3", "schema", "tableName" ] } } }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesS3:AnalyticsApplicationReferenceDataSourcesS3": { "properties": { "bucketArn": { "type": "string", "description": "The S3 Bucket ARN.\n" }, "fileKey": { "type": "string", "description": "The File Key name containing reference data.\n" }, "roleArn": { "type": "string", "description": "The IAM Role ARN to read the data.\n" } }, "type": "object", "required": [ "bucketArn", "fileKey", "roleArn" ] }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchema:AnalyticsApplicationReferenceDataSourcesSchema": { "properties": { "recordColumns": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordColumn:AnalyticsApplicationReferenceDataSourcesSchemaRecordColumn" }, "description": "The Record Column mapping for the streaming source data element.\nSee Record Columns below for more details.\n" }, "recordEncoding": { "type": "string", "description": "The Encoding of the record in the streaming source.\n" }, "recordFormat": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormat:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormat", "description": "The Record Format and mapping information to schematize a record.\nSee Record Format below for more details.\n" } }, "type": "object", "required": [ "recordColumns", "recordFormat" ] }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordColumn:AnalyticsApplicationReferenceDataSourcesSchemaRecordColumn": { "properties": { "mapping": { "type": "string", "description": "The Mapping reference to the data element.\n" }, "name": { "type": "string", "description": "Name of the column.\n" }, "sqlType": { "type": "string", "description": "The SQL Type of the column.\n" } }, "type": "object", "required": [ "name", "sqlType" ] }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormat:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormat": { "properties": { "mappingParameters": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParameters:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParameters", "description": "The Mapping Information for the record format.\nSee Mapping Parameters below for more details.\n" }, "recordFormatType": { "type": "string", "description": "The type of Record Format. Can be `CSV` or `JSON`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "recordFormatType" ] } } }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParameters:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParameters": { "properties": { "csv": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersCsv:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersCsv", "description": "Mapping information when the record format uses delimiters.\nSee CSV Mapping Parameters below for more details.\n" }, "json": { "$ref": "#/types/aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersJson:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersJson", "description": "Mapping information when JSON is the record format on the streaming source.\nSee JSON Mapping Parameters below for more details.\n" } }, "type": "object" }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersCsv:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersCsv": { "properties": { "recordColumnDelimiter": { "type": "string", "description": "The Column Delimiter.\n" }, "recordRowDelimiter": { "type": "string", "description": "The Row Delimiter.\n" } }, "type": "object", "required": [ "recordColumnDelimiter", "recordRowDelimiter" ] }, "aws:kinesis/AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersJson:AnalyticsApplicationReferenceDataSourcesSchemaRecordFormatMappingParametersJson": { "properties": { "recordRowPath": { "type": "string", "description": "Path to the top-level parent that contains the records.\n" } }, "type": "object", "required": [ "recordRowPath" ] }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfiguration:FirehoseDeliveryStreamElasticsearchConfiguration": { "properties": { "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "clusterEndpoint": { "type": "string", "description": "The endpoint to use when communicating with the cluster. Conflicts with `domain_arn`.\n" }, "domainArn": { "type": "string", "description": "The ARN of the Amazon ES domain. The pattern needs to be `arn:.*`. Conflicts with `cluster_endpoint`.\n" }, "indexName": { "type": "string", "description": "The Elasticsearch index name.\n" }, "indexRotationPeriod": { "type": "string", "description": "The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. Valid values are `NoRotation`, `OneHour`, `OneDay`, `OneWeek`, and `OneMonth`. The default value is `OneDay`.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "After an initial failure to deliver to Amazon Elasticsearch, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. The IAM role must have permission for `DescribeElasticsearchDomain`, `DescribeElasticsearchDomains`, and `DescribeElasticsearchDomainConfig`. The pattern needs to be `arn:.*`.\n" }, "s3BackupMode": { "type": "string", "description": "Defines how documents should be delivered to Amazon S3. Valid values are `FailedDocumentsOnly` and `AllDocuments`. Default value is `FailedDocumentsOnly`.\n", "willReplaceOnChanges": true }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationS3Configuration:FirehoseDeliveryStreamElasticsearchConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" }, "typeName": { "type": "string", "description": "The Elasticsearch type name with maximum length of 100 characters.\n" }, "vpcConfig": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationVpcConfig:FirehoseDeliveryStreamElasticsearchConfigurationVpcConfig", "description": "The VPC configuration for the delivery stream to connect to Elastic Search associated with the VPC. See `vpc_config` block below for details.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "indexName", "roleArn", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "indexName", "roleArn", "s3Configuration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationS3Configuration:FirehoseDeliveryStreamElasticsearchConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamElasticsearchConfigurationVpcConfig:FirehoseDeliveryStreamElasticsearchConfigurationVpcConfig": { "properties": { "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon EC2 configuration API and for creating network interfaces. Make sure role has necessary [IAM permissions](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es-vpc)\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "roleArn", "securityGroupIds", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "roleArn", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3Configuration:FirehoseDeliveryStreamExtendedS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "type": "integer" }, "bufferingSize": { "type": "integer" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamExtendedS3ConfigurationCloudwatchLoggingOptions" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "customTimeZone": { "type": "string", "description": "The time zone you prefer. Valid values are `UTC` or a non-3-letter IANA time zones (for example, `America/Los_Angeles`). Default value is `UTC`.\n" }, "dataFormatConversionConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfiguration", "description": "Nested argument for the serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. See `data_format_conversion_configuration` block below for details.\n" }, "dynamicPartitioningConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDynamicPartitioningConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDynamicPartitioningConfiguration", "description": "The configuration for dynamic partitioning. Required when using [dynamic partitioning](https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html). See `dynamic_partitioning_configuration` block below for details.\n", "willReplaceOnChanges": true }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "fileExtension": { "type": "string", "description": "The file extension to override the default file extension (for example, `.json`).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "roleArn": { "type": "string" }, "s3BackupConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfiguration", "description": "The configuration for backup in Amazon S3. Required if `s3_backup_mode` is `Enabled`. Supports the same fields as `s3_configuration` object.\n" }, "s3BackupMode": { "type": "string", "description": "The Amazon S3 backup mode. Valid values are `Disabled` and `Enabled`. Default value is `Disabled`.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamExtendedS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Defaults to `true`. Set it to `false` if you want to disable format conversion while preserving the configuration details.\n" }, "inputFormatConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfiguration", "description": "Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. See `input_format_configuration` block below for details.\n" }, "outputFormatConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfiguration", "description": "Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. See `output_format_configuration` block below for details.\n" }, "schemaConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationSchemaConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationSchemaConfiguration", "description": "Specifies the AWS Glue Data Catalog table that contains the column information. See `schema_configuration` block below for details.\n" } }, "type": "object", "required": [ "inputFormatConfiguration", "outputFormatConfiguration", "schemaConfiguration" ] }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfiguration": { "properties": { "deserializer": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializer:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializer", "description": "Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. See `deserializer` block below for details.\n" } }, "type": "object", "required": [ "deserializer" ] }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializer:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializer": { "properties": { "hiveJsonSerDe": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerHiveJsonSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerHiveJsonSerDe", "description": "Specifies the native Hive / HCatalog JsonSerDe. More details below. See `hive_json_ser_de` block below for details.\n" }, "openXJsonSerDe": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerOpenXJsonSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerOpenXJsonSerDe", "description": "Specifies the OpenX SerDe. See `open_x_json_ser_de` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerHiveJsonSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerHiveJsonSerDe": { "properties": { "timestampFormats": { "type": "array", "items": { "type": "string" }, "description": "A list of how you want Kinesis Data Firehose to parse the date and time stamps 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://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html). You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerOpenXJsonSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationInputFormatConfigurationDeserializerOpenXJsonSerDe": { "properties": { "caseInsensitive": { "type": "boolean", "description": "When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.\n" }, "columnToJsonKeyMappings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of 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.\n" }, "convertDotsInJsonKeysToUnderscores": { "type": "boolean", "description": "When set to `true`, specifies that the names of the keys include dots and that you want Kinesis Data 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. Defaults to `false`.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfiguration": { "properties": { "serializer": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializer:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializer", "description": "Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. See `serializer` block below for details.\n" } }, "type": "object", "required": [ "serializer" ] }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializer:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializer": { "properties": { "orcSerDe": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerOrcSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerOrcSerDe", "description": "Specifies converting data to the ORC format before storing it in Amazon S3. For more information, see [Apache ORC](https://orc.apache.org/docs/). See `orc_ser_de` block below for details.\n" }, "parquetSerDe": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerParquetSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerParquetSerDe", "description": "Specifies converting data to the Parquet format before storing it in Amazon S3. For more information, see [Apache Parquet](https://parquet.apache.org/docs/). More details below.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerOrcSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerOrcSerDe": { "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. Kinesis Data Firehose uses this value for padding calculations.\n" }, "bloomFilterColumns": { "type": "array", "items": { "type": "string" }, "description": "A list of column names for which you want Kinesis Data Firehose to create bloom filters.\n" }, "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`.\n" }, "compression": { "type": "string", "description": "The compression code to use over data blocks. The default is `SNAPPY`.\n" }, "dictionaryKeyThreshold": { "type": "number", "description": "A float that 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`.\n" }, "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`.\n" }, "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`.\n" }, "paddingTolerance": { "type": "number", "description": "A float 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. For 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. Kinesis Data Firehose ignores this parameter when `enable_padding` is `false`.\n" }, "rowIndexStride": { "type": "integer", "description": "The number of rows between index entries. The default is `10000` and the minimum is `1000`.\n" }, "stripeSizeBytes": { "type": "integer", "description": "The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerParquetSerDe:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationOutputFormatConfigurationSerializerParquetSerDe": { "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. Kinesis Data Firehose uses this value for padding calculations.\n" }, "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.\n" }, "enableDictionaryCompression": { "type": "boolean", "description": "Indicates whether to enable dictionary compression.\n" }, "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`.\n" }, "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.\n" }, "writerVersion": { "type": "string", "description": "Indicates the version of row format to output. The possible values are `V1` and `V2`. The default is `V1`.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationSchemaConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDataFormatConversionConfigurationSchemaConfiguration": { "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.\n" }, "databaseName": { "type": "string", "description": "Specifies the name of the AWS Glue database that contains the schema for the output data.\n" }, "region": { "type": "string", "description": "If you don't specify an AWS Region, the default is the current region.\n" }, "roleArn": { "type": "string", "description": "The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.\n" }, "tableName": { "type": "string", "description": "Specifies the AWS Glue table that contains the column information that constitutes your data schema.\n" }, "versionId": { "type": "string", "description": "Specifies the table version for the output data schema. Defaults to `LATEST`.\n" } }, "type": "object", "required": [ "databaseName", "roleArn", "tableName" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "databaseName", "region", "roleArn", "tableName" ] } } }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationDynamicPartitioningConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationDynamicPartitioningConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables dynamic partitioning. Defaults to `false`.\n", "willReplaceOnChanges": true }, "retryDuration": { "type": "integer", "description": "Total amount of seconds Firehose spends on retries. Valid values between 0 and 7200. Default is 300.\n\n\u003e **NOTE:** You can enable dynamic partitioning only when you create a new delivery stream. Once you enable dynamic partitioning on a delivery stream, it cannot be disabled on this delivery stream. Therefore, the provider will recreate the resource whenever dynamic partitioning is enabled or disabled.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamExtendedS3ConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfiguration:FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfiguration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "type": "integer" }, "bufferingSize": { "type": "integer" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfigurationCloudwatchLoggingOptions" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamExtendedS3ConfigurationS3BackupConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfiguration:FirehoseDeliveryStreamHttpEndpointConfiguration": { "properties": { "accessKey": { "type": "string", "description": "The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.\n", "secret": true }, "bufferingInterval": { "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).\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamHttpEndpointConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "name": { "type": "string", "description": "The HTTP endpoint name.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "requestConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfiguration", "description": "The request configuration. See `request_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "Total amount of seconds Firehose spends on retries. This duration starts after the initial attempt fails, It does not include the time periods during which Firehose waits for acknowledgment from the specified destination after each attempt. Valid values between `0` and `7200`. Default is `300`.\n" }, "roleArn": { "type": "string", "description": "Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs. The pattern needs to be `arn:.*`.\n" }, "s3BackupMode": { "type": "string", "description": "Defines how documents should be delivered to Amazon S3. Valid values are `FailedDataOnly` and `AllData`. Default value is `FailedDataOnly`.\n" }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationS3Configuration:FirehoseDeliveryStreamHttpEndpointConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" }, "secretsManagerConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationSecretsManagerConfiguration", "description": "The Secret Manager Configuration. See `secrets_manager_configuration` block below for details.\n" }, "url": { "type": "string", "description": "The HTTP endpoint URL to which Kinesis Firehose sends your data.\n" } }, "type": "object", "required": [ "s3Configuration", "url" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "requestConfiguration", "s3Configuration", "secretsManagerConfiguration", "url" ] } } }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamHttpEndpointConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamHttpEndpointConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfiguration": { "properties": { "commonAttributes": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfigurationCommonAttribute:FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfigurationCommonAttribute" }, "description": "Describes the metadata sent to the HTTP endpoint destination. See `common_attributes` block below for details.\n" }, "contentEncoding": { "type": "string", "description": "Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. Valid values are `NONE` and `GZIP`. Default value is `NONE`.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfigurationCommonAttribute:FirehoseDeliveryStreamHttpEndpointConfigurationRequestConfigurationCommonAttribute": { "properties": { "name": { "type": "string", "description": "The name of the HTTP endpoint common attribute.\n" }, "value": { "type": "string", "description": "The value of the HTTP endpoint common attribute.\n" } }, "type": "object", "required": [ "name", "value" ] }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationS3Configuration:FirehoseDeliveryStreamHttpEndpointConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamHttpEndpointConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamHttpEndpointConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamHttpEndpointConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamHttpEndpointConfigurationSecretsManagerConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the Secrets Manager configuration.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role the stream assumes.\n" }, "secretArn": { "type": "string", "description": "The ARN of the Secrets Manager secret. This value is required if `enabled` is true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfiguration:FirehoseDeliveryStreamIcebergConfiguration": { "properties": { "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 and 900, before delivering it to the destination. The default value is 300.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 and 128, before delivering it to the destination. The default value is 5.\n" }, "catalogArn": { "type": "string", "description": "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`\n", "willReplaceOnChanges": true }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamIcebergConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "destinationTableConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationDestinationTableConfiguration:FirehoseDeliveryStreamIcebergConfigurationDestinationTableConfiguration" }, "description": "Destination table configurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided. See `destination_table_configuration` block below for details.\n", "willReplaceOnChanges": true }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfiguration:FirehoseDeliveryStreamIcebergConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "The period of time, in seconds between 0 to 7200, during which Firehose retries to deliver data to the specified destination.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.\n" }, "s3BackupMode": { "type": "string" }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationS3Configuration:FirehoseDeliveryStreamIcebergConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" } }, "type": "object", "required": [ "catalogArn", "roleArn", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "catalogArn", "cloudwatchLoggingOptions", "roleArn", "s3Configuration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamIcebergConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationDestinationTableConfiguration:FirehoseDeliveryStreamIcebergConfigurationDestinationTableConfiguration": { "properties": { "databaseName": { "type": "string", "description": "The name of the Apache Iceberg database.\n" }, "s3ErrorOutputPrefix": { "type": "string", "description": "The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.\n" }, "tableName": { "type": "string", "description": "The name of the Apache Iceberg Table.\n" }, "uniqueKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.\n" } }, "type": "object", "required": [ "databaseName", "tableName" ] }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfiguration:FirehoseDeliveryStreamIcebergConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamIcebergConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationS3Configuration:FirehoseDeliveryStreamIcebergConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamIcebergConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamIcebergConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamIcebergConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamKinesisSourceConfiguration:FirehoseDeliveryStreamKinesisSourceConfiguration": { "properties": { "kinesisStreamArn": { "type": "string", "description": "The kinesis stream used as the source of the firehose delivery stream.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role that provides access to the source Kinesis stream.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "kinesisStreamArn", "roleArn" ] }, "aws:kinesis/FirehoseDeliveryStreamMskSourceConfiguration:FirehoseDeliveryStreamMskSourceConfiguration": { "properties": { "authenticationConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamMskSourceConfigurationAuthenticationConfiguration:FirehoseDeliveryStreamMskSourceConfigurationAuthenticationConfiguration", "description": "The authentication configuration of the Amazon MSK cluster. See `authentication_configuration` block below for details.\n", "willReplaceOnChanges": true }, "mskClusterArn": { "type": "string", "description": "The ARN of the Amazon MSK cluster.\n", "willReplaceOnChanges": true }, "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. If you want to create a Firehose stream with Earliest start position set the `read_from_timestamp` parameter to Epoch (1970-01-01T00:00:00Z).\n", "willReplaceOnChanges": true }, "topicName": { "type": "string", "description": "The topic name within the Amazon MSK cluster.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "authenticationConfiguration", "mskClusterArn", "topicName" ] }, "aws:kinesis/FirehoseDeliveryStreamMskSourceConfigurationAuthenticationConfiguration:FirehoseDeliveryStreamMskSourceConfigurationAuthenticationConfiguration": { "properties": { "connectivity": { "type": "string", "description": "The type of connectivity used to access the Amazon MSK cluster. Valid values: `PUBLIC`, `PRIVATE`.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role used to access the Amazon MSK cluster.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "connectivity", "roleArn" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfiguration:FirehoseDeliveryStreamOpensearchConfiguration": { "properties": { "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "clusterEndpoint": { "type": "string", "description": "The endpoint to use when communicating with the cluster. Conflicts with `domain_arn`.\n" }, "documentIdOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationDocumentIdOptions:FirehoseDeliveryStreamOpensearchConfigurationDocumentIdOptions", "description": "The method for setting up document ID. See [`document_id_options` block] below for details.\n" }, "domainArn": { "type": "string", "description": "The ARN of the Amazon ES domain. The pattern needs to be `arn:.*`. Conflicts with `cluster_endpoint`.\n" }, "indexName": { "type": "string", "description": "The OpenSearch index name.\n" }, "indexRotationPeriod": { "type": "string", "description": "The OpenSearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. Valid values are `NoRotation`, `OneHour`, `OneDay`, `OneWeek`, and `OneMonth`. The default value is `OneDay`.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfiguration:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "After an initial failure to deliver to Amazon OpenSearch, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. The IAM role must have permission for `DescribeDomain`, `DescribeDomains`, and `DescribeDomainConfig`. The pattern needs to be `arn:.*`.\n" }, "s3BackupMode": { "type": "string", "description": "Defines how documents should be delivered to Amazon S3. Valid values are `FailedDocumentsOnly` and `AllDocuments`. Default value is `FailedDocumentsOnly`.\n", "willReplaceOnChanges": true }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationS3Configuration:FirehoseDeliveryStreamOpensearchConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" }, "typeName": { "type": "string", "description": "The Elasticsearch type name with maximum length of 100 characters. Types are deprecated in OpenSearch_1.1. TypeName must be empty.\n" }, "vpcConfig": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationVpcConfig:FirehoseDeliveryStreamOpensearchConfigurationVpcConfig", "description": "The VPC configuration for the delivery stream to connect to OpenSearch associated with the VPC. See `vpc_config` block below for details.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "indexName", "roleArn", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "indexName", "roleArn", "s3Configuration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationDocumentIdOptions:FirehoseDeliveryStreamOpensearchConfigurationDocumentIdOptions": { "properties": { "defaultDocumentIdFormat": { "type": "string", "description": "The method for setting up document ID. Valid values: `FIREHOSE_DEFAULT`, `NO_DOCUMENT_ID`.\n" } }, "type": "object", "required": [ "defaultDocumentIdFormat" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfiguration:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationS3Configuration:FirehoseDeliveryStreamOpensearchConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchConfigurationVpcConfig:FirehoseDeliveryStreamOpensearchConfigurationVpcConfig": { "properties": { "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon EC2 configuration API and for creating network interfaces. Make sure role has necessary [IAM permissions](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es-vpc)\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "roleArn", "securityGroupIds", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "roleArn", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfiguration:FirehoseDeliveryStreamOpensearchserverlessConfiguration": { "properties": { "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "collectionEndpoint": { "type": "string", "description": "The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.\n" }, "indexName": { "type": "string", "description": "The Serverless offering for Amazon OpenSearch Service index name.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time, in seconds between 0 to 7200, during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.\n" }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents. The pattern needs to be `arn:.*`.\n" }, "s3BackupMode": { "type": "string", "description": "Defines how documents should be delivered to Amazon S3. Valid values are `FailedDocumentsOnly` and `AllDocuments`. Default value is `FailedDocumentsOnly`.\n", "willReplaceOnChanges": true }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration:FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" }, "vpcConfig": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig:FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig", "description": "The VPC configuration for the delivery stream to connect to OpenSearch Serverless associated with the VPC. See `vpc_config` block below for details.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "collectionEndpoint", "indexName", "roleArn", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "collectionEndpoint", "indexName", "roleArn", "s3Configuration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration:FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchserverlessConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamOpensearchserverlessConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig:FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig": { "properties": { "roleArn": { "type": "string", "description": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon EC2 configuration API and for creating network interfaces. Make sure role has necessary [IAM permissions](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-es-vpc)\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs to associate with Kinesis Firehose.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "roleArn", "securityGroupIds", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "roleArn", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfiguration:FirehoseDeliveryStreamRedshiftConfiguration": { "properties": { "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "clusterJdbcurl": { "type": "string", "description": "The jdbcurl of the redshift cluster.\n" }, "copyOptions": { "type": "string", "description": "Copy options for copying the data from the s3 intermediate bucket into redshift, for example to change the default delimiter. For valid values, see the [AWS documentation](http://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html)\n" }, "dataTableColumns": { "type": "string", "description": "The data table columns that will be targeted by the copy command.\n" }, "dataTableName": { "type": "string", "description": "The name of the table in the redshift cluster that the s3 bucket will copy to.\n" }, "password": { "type": "string", "description": "The password for the username above. This value is required if `secrets_manager_configuration` is not provided.\n", "secret": true }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfiguration:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "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.\n" }, "roleArn": { "type": "string", "description": "The arn of the role the stream assumes.\n" }, "s3BackupConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfiguration:FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfiguration", "description": "The configuration for backup in Amazon S3. Required if `s3_backup_mode` is `Enabled`. Supports the same fields as `s3_configuration` object.\n`secrets_manager_configuration` - (Optional) The Secrets Manager configuration. See `secrets_manager_configuration` block below for details. This value is required if `username` and `password` are not provided.\n" }, "s3BackupMode": { "type": "string", "description": "The Amazon S3 backup mode. Valid values are `Disabled` and `Enabled`. Default value is `Disabled`.\n" }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3Configuration:FirehoseDeliveryStreamRedshiftConfigurationS3Configuration", "description": "The S3 Configuration. See s3_configuration below for details.\n" }, "secretsManagerConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamRedshiftConfigurationSecretsManagerConfiguration" }, "username": { "type": "string", "description": "The username that the firehose delivery stream will assume. It is strongly recommended that the username and password provided is used exclusively for Amazon Kinesis Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. This value is required if `secrets_manager_configuration` is not provided.\n" } }, "type": "object", "required": [ "clusterJdbcurl", "dataTableName", "roleArn", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "clusterJdbcurl", "dataTableName", "roleArn", "s3Configuration", "secretsManagerConfiguration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfiguration:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamRedshiftConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfiguration:FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfiguration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "type": "integer" }, "bufferingSize": { "type": "integer" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfigurationCloudwatchLoggingOptions" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationS3BackupConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3Configuration:FirehoseDeliveryStreamRedshiftConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamRedshiftConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamRedshiftConfigurationSecretsManagerConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the Secrets Manager configuration.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role the stream assumes.\n" }, "secretArn": { "type": "string", "description": "The ARN of the Secrets Manager secret. This value is required if `enabled` is true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:kinesis/FirehoseDeliveryStreamServerSideEncryption:FirehoseDeliveryStreamServerSideEncryption": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable encryption at rest. Default is `false`.\n" }, "keyArn": { "type": "string", "description": "Amazon Resource Name (ARN) of the encryption key. Required when `key_type` is `CUSTOMER_MANAGED_CMK`.\n" }, "keyType": { "type": "string", "description": "Type of encryption key. Default is `AWS_OWNED_CMK`. Valid values are `AWS_OWNED_CMK` and `CUSTOMER_MANAGED_CMK`\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfiguration:FirehoseDeliveryStreamSnowflakeConfiguration": { "properties": { "accountUrl": { "type": "string", "description": "The URL of the Snowflake account. Format: https://[account_identifier].snowflakecomputing.com.\n" }, "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 0s.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 to 128, before delivering it to the destination. The default value is 1MB.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "contentColumnName": { "type": "string", "description": "The name of the content column.\n" }, "dataLoadingOption": { "type": "string", "description": "The data loading option.\n" }, "database": { "type": "string", "description": "The Snowflake database name.\n" }, "keyPassphrase": { "type": "string", "description": "The passphrase for the private key.\n", "secret": true }, "metadataColumnName": { "type": "string", "description": "The name of the metadata column.\n" }, "privateKey": { "type": "string", "description": "The private key for authentication. This value is required if `secrets_manager_configuration` is not provided.\n", "secret": true }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration", "description": "The processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "After an initial failure to deliver to Snowflake, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 60s. There will be no retry if the value is 0.\n" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role.\n" }, "s3BackupMode": { "type": "string", "description": "The S3 backup mode.\n" }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration:FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration", "description": "The S3 configuration. See `s3_configuration` block below for details.\n" }, "schema": { "type": "string", "description": "The Snowflake schema name.\n" }, "secretsManagerConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration", "description": "The Secrets Manager configuration. See `secrets_manager_configuration` block below for details. This value is required if `user` and `private_key` are not provided.\n" }, "snowflakeRoleConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration", "description": "The configuration for Snowflake role.\n" }, "snowflakeVpcConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration", "description": "The VPC configuration for Snowflake.\n" }, "table": { "type": "string", "description": "The Snowflake table name.\n" }, "user": { "type": "string", "description": "The user for authentication. This value is required if `secrets_manager_configuration` is not provided.\n" } }, "type": "object", "required": [ "accountUrl", "database", "roleArn", "s3Configuration", "schema", "table" ], "language": { "nodejs": { "requiredOutputs": [ "accountUrl", "cloudwatchLoggingOptions", "database", "roleArn", "s3Configuration", "schema", "secretsManagerConfiguration", "table" ] } } }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration:FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSnowflakeConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSnowflakeConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the Secrets Manager configuration.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role the stream assumes.\n" }, "secretArn": { "type": "string", "description": "The ARN of the Secrets Manager secret. This value is required if `enabled` is true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Whether the Snowflake role is enabled.\n" }, "snowflakeRole": { "type": "string", "description": "The Snowflake role.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration:FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration": { "properties": { "privateLinkVpceId": { "type": "string", "description": "The VPCE ID for Firehose to privately connect with Snowflake.\n" } }, "type": "object", "required": [ "privateLinkVpceId" ] }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfiguration:FirehoseDeliveryStreamSplunkConfiguration": { "properties": { "bufferingInterval": { "type": "integer", "description": "Buffer incoming data for the specified period of time, in seconds between 0 to 60, before delivering it to the destination. The default value is 60s.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs between 1 to 5, before delivering it to the destination. The default value is 5MB.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSplunkConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "hecAcknowledgmentTimeout": { "type": "integer", "description": "The amount of time, in seconds between 180 and 600, that Kinesis Firehose waits to receive an acknowledgment from Splunk after it sends it data.\n" }, "hecEndpoint": { "type": "string", "description": "The HTTP Event Collector (HEC) endpoint to which Kinesis Firehose sends your data.\n" }, "hecEndpointType": { "type": "string", "description": "The HEC endpoint type. Valid values are `Raw` or `Event`. The default value is `Raw`.\n" }, "hecToken": { "type": "string", "description": "The GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. This value is required if `secrets_manager_configuration` is not provided.\n" }, "processingConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfiguration:FirehoseDeliveryStreamSplunkConfigurationProcessingConfiguration", "description": "The data processing configuration. See `processing_configuration` block below for details.\n" }, "retryDuration": { "type": "integer", "description": "After an initial failure to deliver to Splunk, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.\n" }, "s3BackupMode": { "type": "string", "description": "Defines how documents should be delivered to Amazon S3. Valid values are `FailedEventsOnly` and `AllEvents`. Default value is `FailedEventsOnly`.\n`secrets_manager_configuration` - (Optional) The Secrets Manager configuration. See `secrets_manager_configuration` block below for details. This value is required if `hec_token` is not provided.\n" }, "s3Configuration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationS3Configuration:FirehoseDeliveryStreamSplunkConfigurationS3Configuration", "description": "The S3 Configuration. See `s3_configuration` block below for details.\n" }, "secretsManagerConfiguration": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamSplunkConfigurationSecretsManagerConfiguration" } }, "type": "object", "required": [ "hecEndpoint", "s3Configuration" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptions", "hecEndpoint", "s3Configuration", "secretsManagerConfiguration" ] } } }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSplunkConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfiguration:FirehoseDeliveryStreamSplunkConfigurationProcessingConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables data processing.\n" }, "processors": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessor" }, "description": "Specifies the data processors as multiple blocks. See `processors` block below for details.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessor:FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessor": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessorParameter" }, "description": "Specifies the processor parameters as multiple blocks. See `parameters` block below for details.\n" }, "type": { "type": "string", "description": "The type of processor. Valid Values: `RecordDeAggregation`, `Lambda`, `MetadataExtraction`, `AppendDelimiterToRecord`, `Decompression`, `CloudWatchLogProcessing`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorType); so values not explicitly listed may also work.\n" } }, "type": "object", "required": [ "type" ] }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessorParameter:FirehoseDeliveryStreamSplunkConfigurationProcessingConfigurationProcessorParameter": { "properties": { "parameterName": { "type": "string", "description": "Parameter name. Valid Values: `LambdaArn`, `NumberOfRetries`, `MetadataExtractionQuery`, `JsonParsingEngine`, `RoleArn`, `BufferSizeInMBs`, `BufferIntervalInSeconds`, `SubRecordType`, `Delimiter`, `CompressionFormat`, `DataMessageExtraction`. Validation is done against [AWS SDK constants](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/firehose/types#ProcessorParameterName); so values not explicitly listed may also work.\n" }, "parameterValue": { "type": "string", "description": "Parameter value. Must be between 1 and 512 length (inclusive). When providing a Lambda ARN, you should specify the resource version as well.\n\n\u003e **NOTE:** Parameters with default values, including `NumberOfRetries`(default: 3), `RoleArn`(default: firehose role ARN), `BufferSizeInMBs`(default: 1), and `BufferIntervalInSeconds`(default: 60), are not stored in Pulumi state. To prevent perpetual differences, it is therefore recommended to only include parameters with non-default values.\n" } }, "type": "object", "required": [ "parameterName", "parameterValue" ] }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationS3Configuration:FirehoseDeliveryStreamSplunkConfigurationS3Configuration": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket\n" }, "bufferingInterval": { "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.\n" }, "bufferingSize": { "type": "integer", "description": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\nWe recommend setting SizeInMBs 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 set SizeInMBs to be 10 MB or higher.\n" }, "cloudwatchLoggingOptions": { "$ref": "#/types/aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSplunkConfigurationS3ConfigurationCloudwatchLoggingOptions", "description": "The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.\n" }, "compressionFormat": { "type": "string", "description": "The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, \u0026 `HADOOP_SNAPPY`.\n" }, "errorOutputPrefix": { "type": "string", "description": "Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. 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).\n" }, "kmsKeyArn": { "type": "string", "description": "Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will\nbe used.\n" }, "prefix": { "type": "string", "description": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket\n" }, "roleArn": { "type": "string", "description": "The ARN of the AWS credentials.\n" } }, "type": "object", "required": [ "bucketArn", "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "bucketArn", "cloudwatchLoggingOptions", "roleArn" ] } } }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationS3ConfigurationCloudwatchLoggingOptions:FirehoseDeliveryStreamSplunkConfigurationS3ConfigurationCloudwatchLoggingOptions": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the logging. Defaults to `false`.\n" }, "logGroupName": { "type": "string", "description": "The CloudWatch group name for logging. This value is required if `enabled` is true.\n" }, "logStreamName": { "type": "string", "description": "The CloudWatch log stream name for logging. This value is required if `enabled` is true.\n" } }, "type": "object" }, "aws:kinesis/FirehoseDeliveryStreamSplunkConfigurationSecretsManagerConfiguration:FirehoseDeliveryStreamSplunkConfigurationSecretsManagerConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the Secrets Manager configuration.\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the role the stream assumes.\n" }, "secretArn": { "type": "string", "description": "The ARN of the Secrets Manager secret. This value is required if `enabled` is true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "aws:kinesis/StreamStreamModeDetails:StreamStreamModeDetails": { "properties": { "streamMode": { "type": "string", "description": "Specifies the capacity mode of the stream. Must be either `PROVISIONED` or `ON_DEMAND`.\n" } }, "type": "object", "required": [ "streamMode" ] }, "aws:kinesis/getStreamStreamModeDetail:getStreamStreamModeDetail": { "properties": { "streamMode": { "type": "string", "description": "Capacity mode of the stream. Either `ON_DEMAND` or `PROVISIONED`.\n" } }, "type": "object", "required": [ "streamMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfiguration:ApplicationApplicationConfiguration": { "properties": { "applicationCodeConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfiguration:ApplicationApplicationConfigurationApplicationCodeConfiguration", "description": "The code location and type parameters for the application.\n" }, "applicationSnapshotConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationSnapshotConfiguration:ApplicationApplicationConfigurationApplicationSnapshotConfiguration", "description": "Describes whether snapshots are enabled for a Flink-based application.\n" }, "environmentProperties": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationEnvironmentProperties:ApplicationApplicationConfigurationEnvironmentProperties", "description": "Describes execution properties for a Flink-based application.\n" }, "flinkApplicationConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfiguration", "description": "The configuration of a Flink-based application.\n" }, "runConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfiguration:ApplicationApplicationConfigurationRunConfiguration", "description": "Describes the starting properties for a Flink-based application.\n" }, "sqlApplicationConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfiguration:ApplicationApplicationConfigurationSqlApplicationConfiguration", "description": "The configuration of a SQL-based application.\n" }, "vpcConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationVpcConfiguration:ApplicationApplicationConfigurationVpcConfiguration", "description": "The VPC configuration of a Flink-based application.\n" } }, "type": "object", "required": [ "applicationCodeConfiguration" ], "language": { "nodejs": { "requiredOutputs": [ "applicationCodeConfiguration", "applicationSnapshotConfiguration", "flinkApplicationConfiguration", "runConfiguration" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfiguration:ApplicationApplicationConfigurationApplicationCodeConfiguration": { "properties": { "codeContent": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContent:ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContent", "description": "The location and type of the application code.\n" }, "codeContentType": { "type": "string", "description": "Specifies whether the code content is in text or zip format. Valid values: `PLAINTEXT`, `ZIPFILE`.\n" } }, "type": "object", "required": [ "codeContentType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContent:ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContent": { "properties": { "s3ContentLocation": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContentS3ContentLocation:ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContentS3ContentLocation", "description": "Information about the Amazon S3 bucket containing the application code.\n" }, "textContent": { "type": "string", "description": "The text-format code for the application.\n" } }, "type": "object" }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContentS3ContentLocation:ApplicationApplicationConfigurationApplicationCodeConfigurationCodeContentS3ContentLocation": { "properties": { "bucketArn": { "type": "string", "description": "The ARN for the S3 bucket containing the application code.\n" }, "fileKey": { "type": "string", "description": "The file key for the object containing the application code.\n" }, "objectVersion": { "type": "string", "description": "The version of the object containing the application code.\n" } }, "type": "object", "required": [ "bucketArn", "fileKey" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationApplicationSnapshotConfiguration:ApplicationApplicationConfigurationApplicationSnapshotConfiguration": { "properties": { "snapshotsEnabled": { "type": "boolean", "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.\n" } }, "type": "object", "required": [ "snapshotsEnabled" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationEnvironmentProperties:ApplicationApplicationConfigurationEnvironmentProperties": { "properties": { "propertyGroups": { "type": "array", "items": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationEnvironmentPropertiesPropertyGroup:ApplicationApplicationConfigurationEnvironmentPropertiesPropertyGroup" }, "description": "Describes the execution property groups.\n" } }, "type": "object", "required": [ "propertyGroups" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationEnvironmentPropertiesPropertyGroup:ApplicationApplicationConfigurationEnvironmentPropertiesPropertyGroup": { "properties": { "propertyGroupId": { "type": "string", "description": "The key of the application execution property key-value map.\n" }, "propertyMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Application execution property key-value map.\n" } }, "type": "object", "required": [ "propertyGroupId", "propertyMap" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfiguration": { "properties": { "checkpointConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationCheckpointConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationCheckpointConfiguration", "description": "Describes an application's checkpointing configuration.\n" }, "monitoringConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationMonitoringConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationMonitoringConfiguration", "description": "Describes configuration parameters for CloudWatch logging for an application.\n" }, "parallelismConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationParallelismConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationParallelismConfiguration", "description": "Describes parameters for how an application executes multiple tasks simultaneously.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "checkpointConfiguration", "monitoringConfiguration", "parallelismConfiguration" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationCheckpointConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationCheckpointConfiguration": { "properties": { "checkpointInterval": { "type": "integer", "description": "Describes the interval in milliseconds between checkpoint operations.\n" }, "checkpointingEnabled": { "type": "boolean", "description": "Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.\n" }, "configurationType": { "type": "string", "description": "Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. Valid values: `CUSTOM`, `DEFAULT`. Set this attribute to `CUSTOM` in order for any specified `checkpointing_enabled`, `checkpoint_interval`, or `min_pause_between_checkpoints` attribute values to be effective. If this attribute is set to `DEFAULT`, the application will always use the following values:\n* `checkpointing_enabled = true`\n* `checkpoint_interval = 60000`\n* `min_pause_between_checkpoints = 5000`\n" }, "minPauseBetweenCheckpoints": { "type": "integer", "description": "Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.\n" } }, "type": "object", "required": [ "configurationType" ], "language": { "nodejs": { "requiredOutputs": [ "checkpointInterval", "checkpointingEnabled", "configurationType", "minPauseBetweenCheckpoints" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationMonitoringConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationMonitoringConfiguration": { "properties": { "configurationType": { "type": "string", "description": "Describes whether to use the default CloudWatch logging configuration for an application. Valid values: `CUSTOM`, `DEFAULT`. Set this attribute to `CUSTOM` in order for any specified `log_level` or `metrics_level` attribute values to be effective.\n" }, "logLevel": { "type": "string", "description": "Describes the verbosity of the CloudWatch Logs for an application. Valid values: `DEBUG`, `ERROR`, `INFO`, `WARN`.\n" }, "metricsLevel": { "type": "string", "description": "Describes the granularity of the CloudWatch Logs for an application. Valid values: `APPLICATION`, `OPERATOR`, `PARALLELISM`, `TASK`.\n" } }, "type": "object", "required": [ "configurationType" ], "language": { "nodejs": { "requiredOutputs": [ "configurationType", "logLevel", "metricsLevel" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationFlinkApplicationConfigurationParallelismConfiguration:ApplicationApplicationConfigurationFlinkApplicationConfigurationParallelismConfiguration": { "properties": { "autoScalingEnabled": { "type": "boolean", "description": "Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.\n" }, "configurationType": { "type": "string", "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. Valid values: `CUSTOM`, `DEFAULT`. Set this attribute to `CUSTOM` in order for any specified `auto_scaling_enabled`, `parallelism`, or `parallelism_per_kpu` attribute values to be effective.\n" }, "parallelism": { "type": "integer", "description": "Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform.\n" }, "parallelismPerKpu": { "type": "integer", "description": "Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.\n" } }, "type": "object", "required": [ "configurationType" ], "language": { "nodejs": { "requiredOutputs": [ "autoScalingEnabled", "configurationType", "parallelism", "parallelismPerKpu" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfiguration:ApplicationApplicationConfigurationRunConfiguration": { "properties": { "applicationRestoreConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfigurationApplicationRestoreConfiguration:ApplicationApplicationConfigurationRunConfigurationApplicationRestoreConfiguration", "description": "The restore behavior of a restarting application.\n" }, "flinkRunConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfigurationFlinkRunConfiguration:ApplicationApplicationConfigurationRunConfigurationFlinkRunConfiguration", "description": "The starting parameters for a Flink-based Kinesis Data Analytics application.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "applicationRestoreConfiguration", "flinkRunConfiguration" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfigurationApplicationRestoreConfiguration:ApplicationApplicationConfigurationRunConfigurationApplicationRestoreConfiguration": { "properties": { "applicationRestoreType": { "type": "string", "description": "Specifies how the application should be restored. Valid values: `RESTORE_FROM_CUSTOM_SNAPSHOT`, `RESTORE_FROM_LATEST_SNAPSHOT`, `SKIP_RESTORE_FROM_SNAPSHOT`.\n" }, "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 `application_restore_type`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "applicationRestoreType" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationRunConfigurationFlinkRunConfiguration:ApplicationApplicationConfigurationRunConfigurationFlinkRunConfiguration": { "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. Default is `false`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowNonRestoredState" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfiguration:ApplicationApplicationConfigurationSqlApplicationConfiguration": { "properties": { "input": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInput", "description": "The input stream used by the application.\n" }, "outputs": { "type": "array", "items": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutput" }, "description": "The destination streams used by the application.\n" }, "referenceDataSource": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSource:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSource", "description": "The reference data source used by the application.\n" } }, "type": "object" }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInput": { "properties": { "inAppStreamNames": { "type": "array", "items": { "type": "string" } }, "inputId": { "type": "string" }, "inputParallelism": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputParallelism:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputParallelism", "description": "Describes the number of in-application streams to create.\n" }, "inputProcessingConfiguration": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfiguration:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfiguration", "description": "The input processing configuration for the input.\nAn input processor transforms records as they are received from the stream, before the application's SQL code executes.\n" }, "inputSchema": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchema", "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.\n" }, "inputStartingPositionConfigurations": { "type": "array", "items": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputStartingPositionConfiguration:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputStartingPositionConfiguration" }, "description": "The point at which the application starts processing records from the streaming source.\n" }, "kinesisFirehoseInput": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisFirehoseInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisFirehoseInput", "description": "If the streaming source is a Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.\n" }, "kinesisStreamsInput": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisStreamsInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisStreamsInput", "description": "If the streaming source is a Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).\n" }, "namePrefix": { "type": "string", "description": "The name prefix to use when creating an in-application stream.\n" } }, "type": "object", "required": [ "inputSchema", "namePrefix" ], "language": { "nodejs": { "requiredOutputs": [ "inAppStreamNames", "inputId", "inputParallelism", "inputSchema", "inputStartingPositionConfigurations", "namePrefix" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputParallelism:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputParallelism": { "properties": { "count": { "type": "integer", "description": "The number of in-application streams to create.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "count" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfiguration:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfiguration": { "properties": { "inputLambdaProcessor": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfigurationInputLambdaProcessor:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfigurationInputLambdaProcessor", "description": "Describes the Lambda function that is used to preprocess the records in the stream before being processed by your application code.\n" } }, "type": "object", "required": [ "inputLambdaProcessor" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfigurationInputLambdaProcessor:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputProcessingConfigurationInputLambdaProcessor": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the Lambda function that operates on records in the stream.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchema": { "properties": { "recordColumns": { "type": "array", "items": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordColumn:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordColumn" }, "description": "Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.\n" }, "recordEncoding": { "type": "string", "description": "Specifies the encoding of the records in the streaming source. For example, `UTF-8`.\n" }, "recordFormat": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormat:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormat", "description": "Specifies the format of the records on the streaming source.\n" } }, "type": "object", "required": [ "recordColumns", "recordFormat" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordColumn:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordColumn": { "properties": { "mapping": { "type": "string", "description": "A reference to the data element in the streaming input or the reference data source.\n" }, "name": { "type": "string", "description": "The name of the column that is created in the in-application input stream or reference table.\n" }, "sqlType": { "type": "string", "description": "The type of column created in the in-application input stream or reference table.\n" } }, "type": "object", "required": [ "name", "sqlType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormat:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormat": { "properties": { "mappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParameters", "description": "Provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.\n" }, "recordFormatType": { "type": "string", "description": "The type of record format. Valid values: `CSV`, `JSON`.\n" } }, "type": "object", "required": [ "mappingParameters", "recordFormatType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParameters": { "properties": { "csvMappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersCsvMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersCsvMappingParameters", "description": "Provides additional mapping information when the record format uses delimiters (for example, CSV).\n" }, "jsonMappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersJsonMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersJsonMappingParameters", "description": "Provides additional mapping information when JSON is the record format on the streaming source.\n" } }, "type": "object" }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersCsvMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersCsvMappingParameters": { "properties": { "recordColumnDelimiter": { "type": "string", "description": "The column delimiter. For example, in a CSV format, a comma (`,`) is the typical column delimiter.\n" }, "recordRowDelimiter": { "type": "string", "description": "The row delimiter. For example, in a CSV format, `\\n` is the typical row delimiter.\n" } }, "type": "object", "required": [ "recordColumnDelimiter", "recordRowDelimiter" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersJsonMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputSchemaRecordFormatMappingParametersJsonMappingParameters": { "properties": { "recordRowPath": { "type": "string", "description": "The path to the top-level parent that contains the records.\n" } }, "type": "object", "required": [ "recordRowPath" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputStartingPositionConfiguration:ApplicationApplicationConfigurationSqlApplicationConfigurationInputInputStartingPositionConfiguration": { "properties": { "inputStartingPosition": { "type": "string", "description": "The starting position on the stream. Valid values: `LAST_STOPPED_POINT`, `NOW`, `TRIM_HORIZON`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "inputStartingPosition" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisFirehoseInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisFirehoseInput": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the delivery stream.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisStreamsInput:ApplicationApplicationConfigurationSqlApplicationConfigurationInputKinesisStreamsInput": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the input Kinesis data stream to read.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutput": { "properties": { "destinationSchema": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputDestinationSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputDestinationSchema", "description": "Describes the data format when records are written to the destination.\n" }, "kinesisFirehoseOutput": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisFirehoseOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisFirehoseOutput", "description": "Identifies a Kinesis Data Firehose delivery stream as the destination.\n" }, "kinesisStreamsOutput": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisStreamsOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisStreamsOutput", "description": "Identifies a Kinesis data stream as the destination.\n" }, "lambdaOutput": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputLambdaOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputLambdaOutput", "description": "Identifies a Lambda function as the destination.\n" }, "name": { "type": "string", "description": "The name of the in-application stream.\n" }, "outputId": { "type": "string" } }, "type": "object", "required": [ "destinationSchema", "name" ], "language": { "nodejs": { "requiredOutputs": [ "destinationSchema", "name", "outputId" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputDestinationSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputDestinationSchema": { "properties": { "recordFormatType": { "type": "string", "description": "Specifies the format of the records on the output stream. Valid values: `CSV`, `JSON`.\n" } }, "type": "object", "required": [ "recordFormatType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisFirehoseOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisFirehoseOutput": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the destination delivery stream to write to.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisStreamsOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputKinesisStreamsOutput": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the destination Kinesis data stream to write to.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationOutputLambdaOutput:ApplicationApplicationConfigurationSqlApplicationConfigurationOutputLambdaOutput": { "properties": { "resourceArn": { "type": "string", "description": "The ARN of the destination Lambda function to write to.\n" } }, "type": "object", "required": [ "resourceArn" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSource:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSource": { "properties": { "referenceId": { "type": "string" }, "referenceSchema": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchema", "description": "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.\n" }, "s3ReferenceDataSource": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceS3ReferenceDataSource:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceS3ReferenceDataSource", "description": "Identifies the S3 bucket and object that contains the reference data.\n" }, "tableName": { "type": "string", "description": "The name of the in-application table to create.\n" } }, "type": "object", "required": [ "referenceSchema", "s3ReferenceDataSource", "tableName" ], "language": { "nodejs": { "requiredOutputs": [ "referenceId", "referenceSchema", "s3ReferenceDataSource", "tableName" ] } } }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchema:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchema": { "properties": { "recordColumns": { "type": "array", "items": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordColumn:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordColumn" }, "description": "Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.\n" }, "recordEncoding": { "type": "string", "description": "Specifies the encoding of the records in the streaming source. For example, `UTF-8`.\n" }, "recordFormat": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormat:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormat", "description": "Specifies the format of the records on the streaming source.\n" } }, "type": "object", "required": [ "recordColumns", "recordFormat" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordColumn:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordColumn": { "properties": { "mapping": { "type": "string", "description": "A reference to the data element in the streaming input or the reference data source.\n" }, "name": { "type": "string", "description": "The name of the column that is created in the in-application input stream or reference table.\n" }, "sqlType": { "type": "string", "description": "The type of column created in the in-application input stream or reference table.\n" } }, "type": "object", "required": [ "name", "sqlType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormat:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormat": { "properties": { "mappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParameters", "description": "Provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.\n" }, "recordFormatType": { "type": "string", "description": "The type of record format. Valid values: `CSV`, `JSON`.\n" } }, "type": "object", "required": [ "mappingParameters", "recordFormatType" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParameters": { "properties": { "csvMappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersCsvMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersCsvMappingParameters", "description": "Provides additional mapping information when the record format uses delimiters (for example, CSV).\n" }, "jsonMappingParameters": { "$ref": "#/types/aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersJsonMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersJsonMappingParameters", "description": "Provides additional mapping information when JSON is the record format on the streaming source.\n" } }, "type": "object" }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersCsvMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersCsvMappingParameters": { "properties": { "recordColumnDelimiter": { "type": "string", "description": "The column delimiter. For example, in a CSV format, a comma (`,`) is the typical column delimiter.\n" }, "recordRowDelimiter": { "type": "string", "description": "The row delimiter. For example, in a CSV format, `\\n` is the typical row delimiter.\n" } }, "type": "object", "required": [ "recordColumnDelimiter", "recordRowDelimiter" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersJsonMappingParameters:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceReferenceSchemaRecordFormatMappingParametersJsonMappingParameters": { "properties": { "recordRowPath": { "type": "string", "description": "The path to the top-level parent that contains the records.\n" } }, "type": "object", "required": [ "recordRowPath" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceS3ReferenceDataSource:ApplicationApplicationConfigurationSqlApplicationConfigurationReferenceDataSourceS3ReferenceDataSource": { "properties": { "bucketArn": { "type": "string", "description": "The ARN of the S3 bucket.\n" }, "fileKey": { "type": "string", "description": "The object key name containing the reference data.\n" } }, "type": "object", "required": [ "bucketArn", "fileKey" ] }, "aws:kinesisanalyticsv2/ApplicationApplicationConfigurationVpcConfiguration:ApplicationApplicationConfigurationVpcConfiguration": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The Security Group IDs used by the VPC configuration.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The Subnet IDs used by the VPC configuration.\n" }, "vpcConfigurationId": { "type": "string" }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetIds", "vpcConfigurationId", "vpcId" ] } } }, "aws:kinesisanalyticsv2/ApplicationCloudwatchLoggingOptions:ApplicationCloudwatchLoggingOptions": { "properties": { "cloudwatchLoggingOptionId": { "type": "string" }, "logStreamArn": { "type": "string", "description": "The ARN of the CloudWatch log stream to receive application messages.\n" } }, "type": "object", "required": [ "logStreamArn" ], "language": { "nodejs": { "requiredOutputs": [ "cloudwatchLoggingOptionId", "logStreamArn" ] } } }, "aws:kms/CustomKeyStoreXksProxyAuthenticationCredential:CustomKeyStoreXksProxyAuthenticationCredential": { "properties": { "accessKeyId": { "type": "string", "description": "A unique identifier for the raw secret access key.\n" }, "rawSecretAccessKey": { "type": "string", "description": "A secret string of 43-64 characters.\n" } }, "type": "object", "required": [ "accessKeyId", "rawSecretAccessKey" ] }, "aws:kms/GrantConstraint:GrantConstraint": { "properties": { "encryptionContextEquals": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A list of key-value pairs that must match the encryption context in subsequent cryptographic operation requests. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint. Conflicts with `encryption_context_subset`.\n", "willReplaceOnChanges": true }, "encryptionContextSubset": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A list of key-value pairs that must be included in the encryption context of subsequent cryptographic operation requests. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs. Conflicts with `encryption_context_equals`.\n", "willReplaceOnChanges": true } }, "type": "object" }, "aws:kms/getKeyMultiRegionConfiguration:getKeyMultiRegionConfiguration": { "properties": { "multiRegionKeyType": { "type": "string", "description": "Indicates whether the KMS key is a `PRIMARY` or `REPLICA` key.\n" }, "primaryKeys": { "type": "array", "items": { "$ref": "#/types/aws:kms/getKeyMultiRegionConfigurationPrimaryKey:getKeyMultiRegionConfigurationPrimaryKey" }, "description": "The key ARN and Region of the primary key. This is the current KMS key if it is the primary key.\n" }, "replicaKeys": { "type": "array", "items": { "$ref": "#/types/aws:kms/getKeyMultiRegionConfigurationReplicaKey:getKeyMultiRegionConfigurationReplicaKey" }, "description": "The key ARNs and Regions of all replica keys. Includes the current KMS key if it is a replica key.\n" } }, "type": "object", "required": [ "multiRegionKeyType", "primaryKeys", "replicaKeys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kms/getKeyMultiRegionConfigurationPrimaryKey:getKeyMultiRegionConfigurationPrimaryKey": { "properties": { "arn": { "type": "string", "description": "The key ARN of a primary or replica key of a multi-Region key.\n" }, "region": { "type": "string", "description": "The AWS Region of a primary or replica key in a multi-Region key.\n" } }, "type": "object", "required": [ "arn", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kms/getKeyMultiRegionConfigurationReplicaKey:getKeyMultiRegionConfigurationReplicaKey": { "properties": { "arn": { "type": "string", "description": "The key ARN of a primary or replica key of a multi-Region key.\n" }, "region": { "type": "string", "description": "The AWS Region of a primary or replica key in a multi-Region key.\n" } }, "type": "object", "required": [ "arn", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kms/getKeyXksKeyConfiguration:getKeyXksKeyConfiguration": { "properties": { "id": { "type": "string", "description": "The globally unique identifier for the key\n" } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:kms/getSecretSecret:getSecretSecret": { "properties": { "context": { "type": "object", "additionalProperties": { "type": "string" } }, "grantTokens": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "payload": { "type": "string" } }, "type": "object", "required": [ "name", "payload" ] }, "aws:kms/getSecretsSecret:getSecretsSecret": { "properties": { "context": { "type": "object", "additionalProperties": { "type": "string" }, "description": "An optional mapping that makes up the Encryption Context for the secret.\n" }, "encryptionAlgorithm": { "type": "string", "description": "The encryption algorithm that will be used to decrypt the ciphertext. This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. Valid Values: SYMMETRIC_DEFAULT | RSAES_OAEP_SHA_1 | RSAES_OAEP_SHA_256 | SM2PKE\n" }, "grantTokens": { "type": "array", "items": { "type": "string" }, "description": "An optional list of Grant Tokens for the secret.\n" }, "keyId": { "type": "string", "description": "Specifies the KMS key that AWS KMS uses to decrypt the ciphertext. This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.\n\nFor more information on `context` and `grant_tokens` see the [KMS\nConcepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html)\n" }, "name": { "type": "string", "description": "Name to export this secret under in the attributes.\n" }, "payload": { "type": "string", "description": "Base64 encoded payload, as returned from a KMS encrypt operation.\n" } }, "type": "object", "required": [ "name", "payload" ] }, "aws:lakeformation/DataCellsFilterTableData:DataCellsFilterTableData": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "A list of column names and/or nested column attributes.\n" }, "columnWildcard": { "$ref": "#/types/aws:lakeformation/DataCellsFilterTableDataColumnWildcard:DataCellsFilterTableDataColumnWildcard", "description": "A wildcard with exclusions. See Column Wildcard below for details.\n" }, "databaseName": { "type": "string", "description": "The name of the database.\n" }, "name": { "type": "string", "description": "The name of the data cells filter.\n" }, "rowFilter": { "$ref": "#/types/aws:lakeformation/DataCellsFilterTableDataRowFilter:DataCellsFilterTableDataRowFilter", "description": "A PartiQL predicate. See Row Filter below for details.\n" }, "tableCatalogId": { "type": "string", "description": "The ID of the Data Catalog.\n" }, "tableName": { "type": "string", "description": "The name of the table.\n" }, "versionId": { "type": "string", "description": "ID of the data cells filter version.\n" } }, "type": "object", "required": [ "databaseName", "name", "tableCatalogId", "tableName" ], "language": { "nodejs": { "requiredOutputs": [ "columnNames", "databaseName", "name", "tableCatalogId", "tableName", "versionId" ] } } }, "aws:lakeformation/DataCellsFilterTableDataColumnWildcard:DataCellsFilterTableDataColumnWildcard": { "properties": { "excludedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "(Optional) Excludes column names. Any column with this name will be excluded.\n" } }, "type": "object" }, "aws:lakeformation/DataCellsFilterTableDataRowFilter:DataCellsFilterTableDataRowFilter": { "properties": { "allRowsWildcard": { "$ref": "#/types/aws:lakeformation/DataCellsFilterTableDataRowFilterAllRowsWildcard:DataCellsFilterTableDataRowFilterAllRowsWildcard", "description": "(Optional) A wildcard that matches all rows.\n" }, "filterExpression": { "type": "string", "description": "(Optional) A filter expression.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterExpression" ] } } }, "aws:lakeformation/DataCellsFilterTableDataRowFilterAllRowsWildcard:DataCellsFilterTableDataRowFilterAllRowsWildcard": { "type": "object" }, "aws:lakeformation/DataCellsFilterTimeouts:DataCellsFilterTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:lakeformation/DataLakeSettingsCreateDatabaseDefaultPermission:DataLakeSettingsCreateDatabaseDefaultPermission": { "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, `DESCRIBE`, and `CREATE_TABLE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html).\n" }, "principal": { "type": "string", "description": "Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `[\"ALL\"]`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "permissions", "principal" ] } } }, "aws:lakeformation/DataLakeSettingsCreateTableDefaultPermission:DataLakeSettingsCreateTableDefaultPermission": { "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, and `DESCRIBE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html).\n" }, "principal": { "type": "string", "description": "Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `[\"ALL\"]`.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "permissions", "principal" ] } } }, "aws:lakeformation/OptInCondition:OptInCondition": { "properties": { "expression": { "type": "string", "description": "List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "expression" ] } } }, "aws:lakeformation/OptInPrincipal:OptInPrincipal": { "properties": { "dataLakePrincipalIdentifier": { "type": "string" } }, "type": "object", "required": [ "dataLakePrincipalIdentifier" ] }, "aws:lakeformation/OptInResourceData:OptInResourceData": { "properties": { "catalogs": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/OptInResourceDataCatalog:OptInResourceDataCatalog" }, "description": "Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. See Catalog for more details.\n" }, "dataCellsFilters": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/OptInResourceDataDataCellsFilter:OptInResourceDataDataCellsFilter" }, "description": "Data cell filter. See Data Cells Filter for more details.\n" }, "dataLocations": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/OptInResourceDataDataLocation:OptInResourceDataDataLocation" }, "description": "Location of an Amazon S3 path where permissions are granted or revoked. See Data Location for more details.\n" }, "database": { "$ref": "#/types/aws:lakeformation/OptInResourceDataDatabase:OptInResourceDataDatabase", "description": "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. See Database for more details.\n" }, "lfTag": { "$ref": "#/types/aws:lakeformation/OptInResourceDataLfTag:OptInResourceDataLfTag", "description": "LF-tag key and values attached to a resource.\n" }, "lfTagExpressions": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/OptInResourceDataLfTagExpression:OptInResourceDataLfTagExpression" }, "description": "Logical expression composed of one or more LF-Tag key:value pairs. See LF-Tag Expression for more details.\n" }, "lfTagPolicies": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/OptInResourceDataLfTagPolicy:OptInResourceDataLfTagPolicy" }, "description": "List of LF-Tag conditions or saved LF-Tag expressions that define a resource's LF-Tag policy. See LF-Tag Policy for more details.\n" }, "table": { "$ref": "#/types/aws:lakeformation/OptInResourceDataTable:OptInResourceDataTable", "description": "Table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. See Table for more details.\n" }, "tableWithColumns": { "$ref": "#/types/aws:lakeformation/OptInResourceDataTableWithColumns:OptInResourceDataTableWithColumns", "description": "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. See Table With Columns for more details.\n" } }, "type": "object" }, "aws:lakeformation/OptInResourceDataCatalog:OptInResourceDataCatalog": { "properties": { "id": { "type": "string", "description": "Identifier for the catalog resource.\n" } }, "type": "object" }, "aws:lakeformation/OptInResourceDataDataCellsFilter:OptInResourceDataDataCellsFilter": { "properties": { "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.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "tableCatalogId": { "type": "string", "description": "ID of the catalog to which the table belongs.\n" }, "tableName": { "type": "string", "description": "Name of the table.\n" } }, "type": "object" }, "aws:lakeformation/OptInResourceDataDataLocation:OptInResourceDataDataLocation": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "resourceArn": { "type": "string", "description": "ARN that uniquely identifies the data location resource.\n" } }, "type": "object", "required": [ "resourceArn" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "resourceArn" ] } } }, "aws:lakeformation/OptInResourceDataDatabase:OptInResourceDataDatabase": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "name": { "type": "string", "description": "Name of the table.\n" } }, "type": "object", "required": [ "name" ] }, "aws:lakeformation/OptInResourceDataLfTag:OptInResourceDataLfTag": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "key", "value" ] } } }, "aws:lakeformation/OptInResourceDataLfTagExpression:OptInResourceDataLfTagExpression": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "name": { "type": "string", "description": "Name of the table.\n" } }, "type": "object", "required": [ "name" ] }, "aws:lakeformation/OptInResourceDataLfTagPolicy:OptInResourceDataLfTagPolicy": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "expressionName": { "type": "string", "description": "If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName .\n" }, "expressions": { "type": "array", "items": { "type": "string" }, "description": "List of LF-tag conditions or a saved expression that apply to the resource's LF-Tag policy.\n" }, "resourceType": { "type": "string", "description": "Resource type for which the LF-tag policy applies.\n" } }, "type": "object", "required": [ "resourceType" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "resourceType" ] } } }, "aws:lakeformation/OptInResourceDataTable:OptInResourceDataTable": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "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.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "wildcard": { "type": "boolean" } }, "type": "object", "required": [ "databaseName" ] }, "aws:lakeformation/OptInResourceDataTableWithColumns:OptInResourceDataTableWithColumns": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "columnNames": { "type": "array", "items": { "type": "string" }, "description": "List of column names for the table. At least one of ColumnNames or ColumnWildcard is required.\n" }, "columnWildcard": { "$ref": "#/types/aws:lakeformation/OptInResourceDataTableWithColumnsColumnWildcard:OptInResourceDataTableWithColumnsColumnWildcard", "description": "Wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.\n" }, "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.\n" }, "name": { "type": "string", "description": "Name of the table.\n" } }, "type": "object", "required": [ "databaseName", "name" ] }, "aws:lakeformation/OptInResourceDataTableWithColumnsColumnWildcard:OptInResourceDataTableWithColumnsColumnWildcard": { "properties": { "excludedColumnNames": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:lakeformation/PermissionsDataCellsFilter:PermissionsDataCellsFilter": { "properties": { "databaseName": { "type": "string", "description": "The name of the database.\n" }, "name": { "type": "string", "description": "The name of the data cells filter.\n" }, "tableCatalogId": { "type": "string", "description": "The ID of the Data Catalog.\n" }, "tableName": { "type": "string", "description": "The name of the table.\n" } }, "type": "object", "required": [ "databaseName", "name", "tableCatalogId", "tableName" ] }, "aws:lakeformation/PermissionsDataLocation:PermissionsDataLocation": { "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN) that uniquely identifies the data location resource.\n\nThe following argument is optional:\n", "willReplaceOnChanges": true }, "catalogId": { "type": "string", "description": "Identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "arn" ], "language": { "nodejs": { "requiredOutputs": [ "arn", "catalogId" ] } } }, "aws:lakeformation/PermissionsDatabase:PermissionsDatabase": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the database resource. Unique to the Data Catalog.\n\nThe following argument is optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "name" ] } } }, "aws:lakeformation/PermissionsLfTag:PermissionsLfTag": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "key": { "type": "string", "description": "The key-name for the tag.\n", "willReplaceOnChanges": true }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of possible values an attribute can take.\n\nThe following argument is optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "key", "values" ] } } }, "aws:lakeformation/PermissionsLfTagPolicy:PermissionsLfTagPolicy": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "expressions": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/PermissionsLfTagPolicyExpression:PermissionsLfTagPolicyExpression" }, "description": "A list of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See `expression` below.\n\nThe following argument is optional:\n" }, "resourceType": { "type": "string", "description": "The resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "expressions", "resourceType" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "expressions", "resourceType" ] } } }, "aws:lakeformation/PermissionsLfTagPolicyExpression:PermissionsLfTagPolicyExpression": { "properties": { "key": { "type": "string", "description": "The key-name of an LF-Tag.\n", "willReplaceOnChanges": true }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of possible values of an LF-Tag.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "values" ] }, "aws:lakeformation/PermissionsTable:PermissionsTable": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "databaseName": { "type": "string", "description": "Name of the database for the table. Unique to a Data Catalog.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the table.\n", "willReplaceOnChanges": true }, "wildcard": { "type": "boolean", "description": "Whether to use a wildcard representing every table under a database. Defaults to `false`.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "databaseName", "name" ] } } }, "aws:lakeformation/PermissionsTableWithColumns:PermissionsTableWithColumns": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "columnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table.\n", "willReplaceOnChanges": true }, "databaseName": { "type": "string", "description": "Name of the database for the table with columns resource. Unique to the Data Catalog.\n", "willReplaceOnChanges": true }, "excludedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table to exclude. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid the provider reporting a difference.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the table resource.\n", "willReplaceOnChanges": true }, "wildcard": { "type": "boolean", "description": "Whether to use a column wildcard. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid the provider reporting a difference.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName", "name" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "databaseName", "name" ] } } }, "aws:lakeformation/ResourceLfTagDatabase:ResourceLfTagDatabase": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "name": { "type": "string", "description": "Name of the database resource. Unique to the Data Catalog.\n\nThe following argument is optional:\n" } }, "type": "object", "required": [ "name" ] }, "aws:lakeformation/ResourceLfTagLfTag:ResourceLfTagLfTag": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "key": { "type": "string", "description": "Key name for an existing LF-tag.\n" }, "value": { "type": "string", "description": "Value from the possible values for the LF-tag.\n\nThe following argument is optional:\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "key", "value" ] } } }, "aws:lakeformation/ResourceLfTagTable:ResourceLfTagTable": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "databaseName": { "type": "string", "description": "Name of the database for the table. Unique to a Data Catalog.\n" }, "name": { "type": "string", "description": "Name of the table.\n" }, "wildcard": { "type": "boolean", "description": "Whether to use a wildcard representing every table under a database. Defaults to `false`.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "databaseName" ] }, "aws:lakeformation/ResourceLfTagTableWithColumns:ResourceLfTagTableWithColumns": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "columnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table.\n" }, "columnWildcard": { "$ref": "#/types/aws:lakeformation/ResourceLfTagTableWithColumnsColumnWildcard:ResourceLfTagTableWithColumnsColumnWildcard", "description": "Option to add column wildcard. See Column Wildcard for more details.\n" }, "databaseName": { "type": "string", "description": "Name of the database for the table with columns resource. Unique to the Data Catalog.\n" }, "name": { "type": "string", "description": "Name of the table resource.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "databaseName", "name" ] }, "aws:lakeformation/ResourceLfTagTableWithColumnsColumnWildcard:ResourceLfTagTableWithColumnsColumnWildcard": { "properties": { "excludedColumnNames": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "aws:lakeformation/ResourceLfTagTimeouts:ResourceLfTagTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:lakeformation/ResourceLfTagsDatabase:ResourceLfTagsDatabase": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the database resource. Unique to the Data Catalog.\n\nThe following argument is optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "name" ] } } }, "aws:lakeformation/ResourceLfTagsLfTag:ResourceLfTagsLfTag": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "key": { "type": "string", "description": "Key name for an existing LF-tag.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Value from the possible values for the LF-tag.\n\nThe following argument is optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "key", "value" ] } } }, "aws:lakeformation/ResourceLfTagsTable:ResourceLfTagsTable": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "databaseName": { "type": "string", "description": "Name of the database for the table. Unique to a Data Catalog.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the table.\n", "willReplaceOnChanges": true }, "wildcard": { "type": "boolean", "description": "Whether to use a wildcard representing every table under a database. Defaults to `false`.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "databaseName", "name" ] } } }, "aws:lakeformation/ResourceLfTagsTableWithColumns:ResourceLfTagsTableWithColumns": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n", "willReplaceOnChanges": true }, "columnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table.\n", "willReplaceOnChanges": true }, "databaseName": { "type": "string", "description": "Name of the database for the table with columns resource. Unique to the Data Catalog.\n", "willReplaceOnChanges": true }, "excludedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table to exclude. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid the provider reporting a difference.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the table resource.\n", "willReplaceOnChanges": true }, "wildcard": { "type": "boolean", "description": "Whether to use a column wildcard. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid the provider reporting a difference.\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "databaseName", "name" ], "language": { "nodejs": { "requiredOutputs": [ "catalogId", "databaseName", "name" ] } } }, "aws:lakeformation/getDataLakeSettingsCreateDatabaseDefaultPermission:getDataLakeSettingsCreateDatabaseDefaultPermission": { "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "List of permissions granted to the principal.\n" }, "principal": { "type": "string", "description": "Principal who is granted permissions.\n" } }, "type": "object", "required": [ "permissions", "principal" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lakeformation/getDataLakeSettingsCreateTableDefaultPermission:getDataLakeSettingsCreateTableDefaultPermission": { "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "List of permissions granted to the principal.\n" }, "principal": { "type": "string", "description": "Principal who is granted permissions.\n" } }, "type": "object", "required": [ "permissions", "principal" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lakeformation/getPermissionsDataCellsFilter:getPermissionsDataCellsFilter": { "properties": { "databaseName": { "type": "string", "description": "The name of the database.\n" }, "name": { "type": "string", "description": "The name of the data cells filter.\n" }, "tableCatalogId": { "type": "string", "description": "The ID of the Data Catalog.\n" }, "tableName": { "type": "string", "description": "The name of the table.\n" } }, "type": "object", "required": [ "databaseName", "name", "tableCatalogId", "tableName" ] }, "aws:lakeformation/getPermissionsDataLocation:getPermissionsDataLocation": { "properties": { "arn": { "type": "string", "description": "ARN that uniquely identifies the data location resource.\n\nThe following argument is optional:\n" }, "catalogId": { "type": "string", "description": "Identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.\n" } }, "type": "object", "required": [ "arn", "catalogId" ], "language": { "nodejs": { "requiredInputs": [ "arn" ] } } }, "aws:lakeformation/getPermissionsDatabase:getPermissionsDatabase": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "name": { "type": "string", "description": "Name of the database resource. Unique to the Data Catalog.\n\nThe following argument is optional:\n" } }, "type": "object", "required": [ "catalogId", "name" ], "language": { "nodejs": { "requiredInputs": [ "name" ] } } }, "aws:lakeformation/getPermissionsLfTag:getPermissionsLfTag": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "key": { "type": "string", "description": "Key-name for the tag.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of possible values an attribute can take.\n\nThe following argument is optional:\n" } }, "type": "object", "required": [ "catalogId", "key", "values" ], "language": { "nodejs": { "requiredInputs": [ "key", "values" ] } } }, "aws:lakeformation/getPermissionsLfTagPolicy:getPermissionsLfTagPolicy": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "expressions": { "type": "array", "items": { "$ref": "#/types/aws:lakeformation/getPermissionsLfTagPolicyExpression:getPermissionsLfTagPolicyExpression" }, "description": "List of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See `expression` below.\n\nThe following argument is optional:\n" }, "resourceType": { "type": "string", "description": "Resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`.\n" } }, "type": "object", "required": [ "catalogId", "expressions", "resourceType" ], "language": { "nodejs": { "requiredInputs": [ "expressions", "resourceType" ] } } }, "aws:lakeformation/getPermissionsLfTagPolicyExpression:getPermissionsLfTagPolicyExpression": { "properties": { "key": { "type": "string", "description": "Key-name of an LF-Tag.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of possible values of an LF-Tag.\n" } }, "type": "object", "required": [ "key", "values" ] }, "aws:lakeformation/getPermissionsTable:getPermissionsTable": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "databaseName": { "type": "string", "description": "Name of the database for the table. Unique to a Data Catalog.\n\nThe following arguments are optional:\n" }, "name": { "type": "string", "description": "Name of the table. At least one of `name` or `wildcard` is required.\n" }, "wildcard": { "type": "boolean", "description": "Whether to use a wildcard representing every table under a database. At least one of `name` or `wildcard` is required. Defaults to `false`.\n" } }, "type": "object", "required": [ "catalogId", "databaseName", "name" ], "language": { "nodejs": { "requiredInputs": [ "databaseName" ] } } }, "aws:lakeformation/getPermissionsTableWithColumns:getPermissionsTableWithColumns": { "properties": { "catalogId": { "type": "string", "description": "Identifier for the Data Catalog. By default, it is the account ID of the caller.\n" }, "columnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table. At least one of `column_names` or `excluded_column_names` is required.\n" }, "databaseName": { "type": "string", "description": "Name of the database for the table with columns resource. Unique to the Data Catalog.\n" }, "excludedColumnNames": { "type": "array", "items": { "type": "string" }, "description": "Set of column names for the table to exclude. At least one of `column_names` or `excluded_column_names` is required.\n" }, "name": { "type": "string", "description": "Name of the table resource.\n\nThe following arguments are optional:\n" }, "wildcard": { "type": "boolean", "description": "Whether to use a wildcard representing every table under a database. At least one of `name` or `wildcard` is required. Defaults to `false`.\n" } }, "type": "object", "required": [ "catalogId", "databaseName", "name" ], "language": { "nodejs": { "requiredInputs": [ "databaseName", "name" ] } } }, "aws:lambda/AliasRoutingConfig:AliasRoutingConfig": { "properties": { "additionalVersionWeights": { "type": "object", "additionalProperties": { "type": "number" }, "description": "A map that defines the proportion of events that should be sent to different versions of a lambda function.\n" } }, "type": "object" }, "aws:lambda/CodePathOptions:CodePathOptions": { "description": "Options to control which paths/packages should be included or excluded in the zip file containing the code for the AWS lambda.", "properties": { "extraExcludePackages": { "type": "array", "items": { "type": "string" }, "description": "Packages to explicitly exclude from the Assets for a serialized closure. This can be used when clients want to trim down the size of a closure, and they know that some package won't ever actually be needed at runtime, but is still a dependency of some package that is being used at runtime." }, "extraIncludePackages": { "type": "array", "items": { "type": "string" }, "description": "Extra packages to include when producing the Assets for a serialized closure. This can be useful if the packages are acquired in a way that the serialization code does not understand. For example, if there was some sort of module that was pulled in based off of a computed string." }, "extraIncludePaths": { "type": "array", "items": { "type": "string" }, "description": "Local file/directory paths that should be included when producing the Assets for a serialized closure." } }, "type": "object", "isOverlay": true }, "aws:lambda/CodeSigningConfigAllowedPublishers:CodeSigningConfigAllowedPublishers": { "properties": { "signingProfileVersionArns": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.\n" } }, "type": "object", "required": [ "signingProfileVersionArns" ] }, "aws:lambda/CodeSigningConfigPolicies:CodeSigningConfigPolicies": { "properties": { "untrustedArtifactOnDeployment": { "type": "string", "description": "Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if code-signing validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log. Valid values: `Warn`, `Enforce`. Default value: `Warn`.\n" } }, "type": "object", "required": [ "untrustedArtifactOnDeployment" ] }, "aws:lambda/EventSourceMappingAmazonManagedKafkaEventSourceConfig:EventSourceMappingAmazonManagedKafkaEventSourceConfig": { "properties": { "consumerGroupId": { "type": "string", "description": "A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [AmazonManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_AmazonManagedKafkaEventSourceConfig.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "consumerGroupId" ] } } }, "aws:lambda/EventSourceMappingDestinationConfig:EventSourceMappingDestinationConfig": { "properties": { "onFailure": { "$ref": "#/types/aws:lambda/EventSourceMappingDestinationConfigOnFailure:EventSourceMappingDestinationConfigOnFailure", "description": "The destination configuration for failed invocations. Detailed below.\n" } }, "type": "object" }, "aws:lambda/EventSourceMappingDestinationConfigOnFailure:EventSourceMappingDestinationConfigOnFailure": { "properties": { "destinationArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the destination resource.\n" } }, "type": "object", "required": [ "destinationArn" ] }, "aws:lambda/EventSourceMappingDocumentDbEventSourceConfig:EventSourceMappingDocumentDbEventSourceConfig": { "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.\n" }, "databaseName": { "type": "string", "description": "The name of the database to consume within the DocumentDB cluster.\n" }, "fullDocument": { "type": "string", "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. Valid values: `UpdateLookup`, `Default`.\n" } }, "type": "object", "required": [ "databaseName" ] }, "aws:lambda/EventSourceMappingFilterCriteria:EventSourceMappingFilterCriteria": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/aws:lambda/EventSourceMappingFilterCriteriaFilter:EventSourceMappingFilterCriteriaFilter" }, "description": "A set of up to 5 filter. If an event satisfies at least one, Lambda sends the event to the function or adds it to the next batch. Detailed below.\n" } }, "type": "object" }, "aws:lambda/EventSourceMappingFilterCriteriaFilter:EventSourceMappingFilterCriteriaFilter": { "properties": { "pattern": { "type": "string", "description": "A filter pattern up to 4096 characters. See [Filter Rule Syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax).\n" } }, "type": "object" }, "aws:lambda/EventSourceMappingMetricsConfig:EventSourceMappingMetricsConfig": { "properties": { "metrics": { "type": "array", "items": { "type": "string" }, "description": "A list containing the metrics to be produced by the event source mapping. Valid values: `EventCount`.\n" } }, "type": "object", "required": [ "metrics" ] }, "aws:lambda/EventSourceMappingProvisionedPollerConfig:EventSourceMappingProvisionedPollerConfig": { "properties": { "maximumPollers": { "type": "integer", "description": "The maximum number of event pollers this event source can scale up to. The range is between 1 and 2000.\n" }, "minimumPollers": { "type": "integer", "description": "The minimum number of event pollers this event source can scale down to. The range is between 1 and 200.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maximumPollers", "minimumPollers" ] } } }, "aws:lambda/EventSourceMappingScalingConfig:EventSourceMappingScalingConfig": { "properties": { "maximumConcurrency": { "type": "integer", "description": "Limits the number of concurrent instances that the Amazon SQS event source can invoke. Must be greater than or equal to `2`. See [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase the concurrency beyond 1000.\n" } }, "type": "object" }, "aws:lambda/EventSourceMappingSelfManagedEventSource:EventSourceMappingSelfManagedEventSource": { "properties": { "endpoints": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of endpoints for the self managed source. For Kafka self-managed sources, the key should be `KAFKA_BOOTSTRAP_SERVERS` and the value should be a string with a comma separated list of broker endpoints.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "endpoints" ] }, "aws:lambda/EventSourceMappingSelfManagedKafkaEventSourceConfig:EventSourceMappingSelfManagedKafkaEventSourceConfig": { "properties": { "consumerGroupId": { "type": "string", "description": "A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [SelfManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_SelfManagedKafkaEventSourceConfig.html).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "consumerGroupId" ] } } }, "aws:lambda/EventSourceMappingSourceAccessConfiguration:EventSourceMappingSourceAccessConfiguration": { "properties": { "type": { "type": "string", "description": "The type of authentication protocol, VPC components, or virtual host for your event source. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/api/API_SourceAccessConfiguration.html).\n" }, "uri": { "type": "string", "description": "The URI for this configuration. For type `VPC_SUBNET` the value should be `subnet:subnet_id` where `subnet_id` is the value you would find in an aws.ec2.Subnet resource's id attribute. For type `VPC_SECURITY_GROUP` the value should be `security_group:security_group_id` where `security_group_id` is the value you would find in an aws.ec2.SecurityGroup resource's id attribute.\n" } }, "type": "object", "required": [ "type", "uri" ] }, "aws:lambda/FunctionDeadLetterConfig:FunctionDeadLetterConfig": { "properties": { "targetArn": { "type": "string", "description": "ARN of an SNS topic or SQS queue to notify when an invocation fails. If this option is used, the function's IAM role must be granted suitable access to write to the target object, which means allowing either the `sns:Publish` or `sqs:SendMessage` action on this ARN, depending on which service is targeted.\n" } }, "type": "object", "required": [ "targetArn" ] }, "aws:lambda/FunctionEnvironment:FunctionEnvironment": { "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of environment variables that are accessible from the function code during execution. If provided at least one key must be present.\n" } }, "type": "object" }, "aws:lambda/FunctionEphemeralStorage:FunctionEphemeralStorage": { "properties": { "size": { "type": "integer", "description": "The size of the Lambda function Ephemeral storage(`/tmp`) represented in MB. The minimum supported `ephemeral_storage` value defaults to `512`MB and the maximum supported value is `10240`MB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "size" ] } } }, "aws:lambda/FunctionEventInvokeConfigDestinationConfig:FunctionEventInvokeConfigDestinationConfig": { "properties": { "onFailure": { "$ref": "#/types/aws:lambda/FunctionEventInvokeConfigDestinationConfigOnFailure:FunctionEventInvokeConfigDestinationConfigOnFailure", "description": "Configuration block with destination configuration for failed asynchronous invocations. See below for details.\n" }, "onSuccess": { "$ref": "#/types/aws:lambda/FunctionEventInvokeConfigDestinationConfigOnSuccess:FunctionEventInvokeConfigDestinationConfigOnSuccess", "description": "Configuration block with destination configuration for successful asynchronous invocations. See below for details.\n" } }, "type": "object" }, "aws:lambda/FunctionEventInvokeConfigDestinationConfigOnFailure:FunctionEventInvokeConfigDestinationConfigOnFailure": { "properties": { "destination": { "type": "string", "description": "Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions.\n" } }, "type": "object", "required": [ "destination" ] }, "aws:lambda/FunctionEventInvokeConfigDestinationConfigOnSuccess:FunctionEventInvokeConfigDestinationConfigOnSuccess": { "properties": { "destination": { "type": "string", "description": "Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions.\n" } }, "type": "object", "required": [ "destination" ] }, "aws:lambda/FunctionFileSystemConfig:FunctionFileSystemConfig": { "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the Amazon EFS Access Point that provides access to the file system.\n" }, "localMountPath": { "type": "string", "description": "Path where the function can access the file system, starting with /mnt/.\n" } }, "type": "object", "required": [ "arn", "localMountPath" ] }, "aws:lambda/FunctionImageConfig:FunctionImageConfig": { "properties": { "commands": { "type": "array", "items": { "type": "string" }, "description": "Parameters that you want to pass in with `entry_point`.\n" }, "entryPoints": { "type": "array", "items": { "type": "string" }, "description": "Entry point to your application, which is typically the location of the runtime executable.\n" }, "workingDirectory": { "type": "string", "description": "Working directory.\n" } }, "type": "object" }, "aws:lambda/FunctionLoggingConfig:FunctionLoggingConfig": { "properties": { "applicationLogLevel": { "type": "string", "description": "for JSON structured logs, choose the detail level of the logs your application sends to CloudWatch when using supported logging libraries.\n" }, "logFormat": { "type": "string", "description": "select between `Text` and structured `JSON` format for your function's logs.\n" }, "logGroup": { "type": "string", "description": "the CloudWatch log group your function sends logs to.\n" }, "systemLogLevel": { "type": "string", "description": "for JSON structured logs, choose the detail level of the Lambda platform event logs sent to CloudWatch, such as `ERROR`, `DEBUG`, or `INFO`.\n" } }, "type": "object", "required": [ "logFormat" ], "language": { "nodejs": { "requiredOutputs": [ "logFormat", "logGroup" ] } } }, "aws:lambda/FunctionSnapStart:FunctionSnapStart": { "properties": { "applyOn": { "type": "string", "description": "Conditions where snap start is enabled. Valid values are `PublishedVersions`.\n" }, "optimizationStatus": { "type": "string", "description": "Optimization status of the snap start configuration. Valid values are `On` and `Off`.\n" } }, "type": "object", "required": [ "applyOn" ], "language": { "nodejs": { "requiredOutputs": [ "applyOn", "optimizationStatus" ] } } }, "aws:lambda/FunctionTracingConfig:FunctionTracingConfig": { "properties": { "mode": { "type": "string", "description": "Whether to sample and trace a subset of incoming requests with AWS X-Ray. Valid values are `PassThrough` and `Active`. If `PassThrough`, Lambda will only trace the request from an upstream service if it contains a tracing header with \"sampled=1\". If `Active`, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.\n" } }, "type": "object", "required": [ "mode" ] }, "aws:lambda/FunctionUrlCors:FunctionUrlCors": { "properties": { "allowCredentials": { "type": "boolean", "description": "Whether to allow cookies or other credentials in requests to the function URL. The default is `false`.\n" }, "allowHeaders": { "type": "array", "items": { "type": "string" }, "description": "The HTTP headers that origins can include in requests to the function URL. For example: `[\"date\", \"keep-alive\", \"x-custom-header\"]`.\n" }, "allowMethods": { "type": "array", "items": { "type": "string" }, "description": "The HTTP methods that are allowed when calling the function URL. For example: `[\"GET\", \"POST\", \"DELETE\"]`, or the wildcard character (`[\"*\"]`).\n" }, "allowOrigins": { "type": "array", "items": { "type": "string" }, "description": "The origins that can access the function URL. You can list any number of specific origins (or the wildcard character (`\"*\"`)), separated by a comma. For example: `[\"https://www.example.com\", \"http://localhost:60905\"]`.\n" }, "exposeHeaders": { "type": "array", "items": { "type": "string" }, "description": "The HTTP headers in your function response that you want to expose to origins that call the function URL.\n" }, "maxAge": { "type": "integer", "description": "The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to `0`, which means that the browser doesn't cache results. The maximum value is `86400`.\n" } }, "type": "object" }, "aws:lambda/FunctionVpcConfig:FunctionVpcConfig": { "properties": { "ipv6AllowedForDualStack": { "type": "boolean", "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Default is `false`.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs associated with the Lambda function.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs associated with the Lambda function.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetIds" ], "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetIds", "vpcId" ] } } }, "aws:lambda/Runtime:Runtime": { "description": "See https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html", "type": "string", "enum": [ { "name": "Dotnet6", "value": "dotnet6" }, { "name": "Dotnet8", "value": "dotnet8" }, { "name": "Java11", "value": "java11" }, { "name": "Java17", "value": "java17" }, { "name": "Java21", "value": "java21" }, { "name": "Java8AL2", "value": "java8.al2" }, { "name": "NodeJS18dX", "value": "nodejs18.x" }, { "name": "NodeJS20dX", "value": "nodejs20.x" }, { "name": "NodeJS22dX", "value": "nodejs22.x" }, { "name": "CustomAL2", "value": "provided.al2" }, { "name": "CustomAL2023", "value": "provided.al2023" }, { "name": "Python3d10", "value": "python3.10" }, { "name": "Python3d11", "value": "python3.11" }, { "name": "Python3d12", "value": "python3.12" }, { "name": "Python3d13", "value": "python3.13" }, { "name": "Python3d9", "value": "python3.9" }, { "name": "Ruby3d2", "value": "ruby3.2" }, { "name": "Ruby3d3", "value": "ruby3.3" }, { "name": "Dotnet5d0", "value": "dotnet5.0", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Dotnet7", "value": "dotnet7", "deprecationMessage": "This runtime is now deprecated" }, { "name": "DotnetCore2d1", "value": "dotnetcore2.1", "deprecationMessage": "This runtime is now deprecated" }, { "name": "DotnetCore3d1", "value": "dotnetcore3.1", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Go1dx", "value": "go1.x", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Java8", "value": "java8", "deprecationMessage": "This runtime is now deprecated" }, { "name": "NodeJS10dX", "value": "nodejs10.x", "deprecationMessage": "This runtime is now deprecated" }, { "name": "NodeJS12dX", "value": "nodejs12.x", "deprecationMessage": "This runtime is now deprecated" }, { "name": "NodeJS14dX", "value": "nodejs14.x", "deprecationMessage": "This runtime is now deprecated" }, { "name": "NodeJS16dX", "value": "nodejs16.x", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Custom", "value": "provided", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Python2d7", "value": "python2.7", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Python3d6", "value": "python3.6", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Python3d7", "value": "python3.7", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Python3d8", "value": "python3.8", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Ruby2d5", "value": "ruby2.5", "deprecationMessage": "This runtime is now deprecated" }, { "name": "Ruby2d7", "value": "ruby2.7", "deprecationMessage": "This runtime is now deprecated" } ] }, "aws:lambda/getCodeSigningConfigAllowedPublisher:getCodeSigningConfigAllowedPublisher": { "properties": { "signingProfileVersionArns": { "type": "array", "items": { "type": "string" }, "description": "The ARN for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.\n" } }, "type": "object", "required": [ "signingProfileVersionArns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getCodeSigningConfigPolicy:getCodeSigningConfigPolicy": { "properties": { "untrustedArtifactOnDeployment": { "type": "string", "description": "Code signing configuration policy for deployment validation failure.\n" } }, "type": "object", "required": [ "untrustedArtifactOnDeployment" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionDeadLetterConfig:getFunctionDeadLetterConfig": { "properties": { "targetArn": { "type": "string" } }, "type": "object", "required": [ "targetArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionEnvironment:getFunctionEnvironment": { "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "variables" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionEphemeralStorage:getFunctionEphemeralStorage": { "properties": { "size": { "type": "integer" } }, "type": "object", "required": [ "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionFileSystemConfig:getFunctionFileSystemConfig": { "properties": { "arn": { "type": "string", "description": "Unqualified (no `:QUALIFIER` or `:VERSION` suffix) ARN identifying your Lambda Function. See also `qualified_arn`.\n" }, "localMountPath": { "type": "string" } }, "type": "object", "required": [ "arn", "localMountPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionLoggingConfig:getFunctionLoggingConfig": { "properties": { "applicationLogLevel": { "type": "string" }, "logFormat": { "type": "string" }, "logGroup": { "type": "string" }, "systemLogLevel": { "type": "string" } }, "type": "object", "required": [ "applicationLogLevel", "logFormat", "logGroup", "systemLogLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionTracingConfig:getFunctionTracingConfig": { "properties": { "mode": { "type": "string" } }, "type": "object", "required": [ "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionUrlCor:getFunctionUrlCor": { "properties": { "allowCredentials": { "type": "boolean" }, "allowHeaders": { "type": "array", "items": { "type": "string" } }, "allowMethods": { "type": "array", "items": { "type": "string" } }, "allowOrigins": { "type": "array", "items": { "type": "string" } }, "exposeHeaders": { "type": "array", "items": { "type": "string" } }, "maxAge": { "type": "integer" } }, "type": "object", "required": [ "allowCredentials", "allowHeaders", "allowMethods", "allowOrigins", "exposeHeaders", "maxAge" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lambda/getFunctionVpcConfig:getFunctionVpcConfig": { "properties": { "ipv6AllowedForDualStack": { "type": "boolean" }, "securityGroupIds": { "type": "array", "items": { "type": "string" } }, "subnetIds": { "type": "array", "items": { "type": "string" } }, "vpcId": { "type": "string" } }, "type": "object", "required": [ "ipv6AllowedForDualStack", "securityGroupIds", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/ListenerDefaultAction:ListenerDefaultAction": { "properties": { "authenticateCognito": { "$ref": "#/types/aws:lb/ListenerDefaultActionAuthenticateCognito:ListenerDefaultActionAuthenticateCognito", "description": "Configuration block for using Amazon Cognito to authenticate users. Specify only when `type` is `authenticate-cognito`. See below.\n" }, "authenticateOidc": { "$ref": "#/types/aws:lb/ListenerDefaultActionAuthenticateOidc:ListenerDefaultActionAuthenticateOidc", "description": "Configuration block for an identity provider that is compliant with OpenID Connect (OIDC). Specify only when `type` is `authenticate-oidc`. See below.\n" }, "fixedResponse": { "$ref": "#/types/aws:lb/ListenerDefaultActionFixedResponse:ListenerDefaultActionFixedResponse", "description": "Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`.\n" }, "forward": { "$ref": "#/types/aws:lb/ListenerDefaultActionForward:ListenerDefaultActionForward", "description": "Configuration block for creating an action that distributes requests among one or more target groups. Specify only if `type` is `forward`. See below.\n" }, "order": { "type": "integer", "description": "Order for the action. The action with the lowest value for order is performed first. Valid values are between `1` and `50000`. Defaults to the position in the list of actions.\n" }, "redirect": { "$ref": "#/types/aws:lb/ListenerDefaultActionRedirect:ListenerDefaultActionRedirect", "description": "Configuration block for creating a redirect action. Required if `type` is `redirect`. See below.\n" }, "targetGroupArn": { "type": "string", "description": "ARN of the Target Group to which to route traffic. Specify only if `type` is `forward` and you want to route to a single target group. To route to one or more target groups, use a `forward` block instead. Can be specified with `forward` but ARNs must match.\n" }, "type": { "type": "string", "description": "Type of routing action. Valid values are `forward`, `redirect`, `fixed-response`, `authenticate-cognito` and `authenticate-oidc`.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "order", "type" ] } } }, "aws:lb/ListenerDefaultActionAuthenticateCognito:ListenerDefaultActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Query parameters to include in the redirect request to the authorization endpoint. Max: 10. See below.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior if the user is not authenticated. Valid values are `deny`, `allow` and `authenticate`.\n" }, "scope": { "type": "string", "description": "Set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session, in seconds.\n" }, "userPoolArn": { "type": "string", "description": "ARN of the Cognito user pool.\n" }, "userPoolClientId": { "type": "string", "description": "ID of the Cognito user pool client.\n" }, "userPoolDomain": { "type": "string", "description": "Domain prefix or fully-qualified domain name of the Cognito user pool.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredOutputs": [ "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "userPoolArn", "userPoolClientId", "userPoolDomain" ] } } }, "aws:lb/ListenerDefaultActionAuthenticateOidc:ListenerDefaultActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "authorizationEndpoint": { "type": "string", "description": "Authorization endpoint of the IdP.\n" }, "clientId": { "type": "string", "description": "OAuth 2.0 client identifier.\n" }, "clientSecret": { "type": "string", "description": "OAuth 2.0 client secret.\n", "secret": true }, "issuer": { "type": "string", "description": "OIDC issuer identifier of the IdP.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "Set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session, in seconds.\n" }, "tokenEndpoint": { "type": "string", "description": "Token endpoint of the IdP.\n" }, "userInfoEndpoint": { "type": "string", "description": "User info endpoint of the IdP.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredOutputs": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "tokenEndpoint", "userInfoEndpoint" ] } } }, "aws:lb/ListenerDefaultActionFixedResponse:ListenerDefaultActionFixedResponse": { "properties": { "contentType": { "type": "string", "description": "Content type. Valid values are `text/plain`, `text/css`, `text/html`, `application/javascript` and `application/json`.\n\nThe following arguments are optional:\n" }, "messageBody": { "type": "string", "description": "Message body.\n" }, "statusCode": { "type": "string", "description": "HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`.\n" } }, "type": "object", "required": [ "contentType" ], "language": { "nodejs": { "requiredOutputs": [ "contentType", "statusCode" ] } } }, "aws:lb/ListenerDefaultActionForward:ListenerDefaultActionForward": { "properties": { "stickiness": { "$ref": "#/types/aws:lb/ListenerDefaultActionForwardStickiness:ListenerDefaultActionForwardStickiness", "description": "Configuration block for target group stickiness for the rule. See below.\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:lb/ListenerDefaultActionForwardTargetGroup:ListenerDefaultActionForwardTargetGroup" }, "description": "Set of 1-5 target group blocks. See below.\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "targetGroups" ] }, "aws:lb/ListenerDefaultActionForwardStickiness:ListenerDefaultActionForwardStickiness": { "properties": { "duration": { "type": "integer", "description": "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).\n\nThe following arguments are optional:\n" }, "enabled": { "type": "boolean", "description": "Whether target group stickiness is enabled. Default is `false`.\n" } }, "type": "object", "required": [ "duration" ] }, "aws:lb/ListenerDefaultActionForwardTargetGroup:ListenerDefaultActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the target group.\n\nThe following arguments are optional:\n" }, "weight": { "type": "integer", "description": "Weight. The range is 0 to 999.\n" } }, "type": "object", "required": [ "arn" ] }, "aws:lb/ListenerDefaultActionRedirect:ListenerDefaultActionRedirect": { "properties": { "host": { "type": "string", "description": "Hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`.\n" }, "path": { "type": "string", "description": "Absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to `/#{path}`.\n" }, "port": { "type": "string", "description": "Port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`.\n" }, "protocol": { "type": "string", "description": "Protocol. Valid values are `HTTP`, `HTTPS`, or `#{protocol}`. Defaults to `#{protocol}`.\n" }, "query": { "type": "string", "description": "Query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\". Defaults to `#{query}`.\n" }, "statusCode": { "type": "string", "description": "HTTP redirect code. The redirect is either permanent (`HTTP_301`) or temporary (`HTTP_302`).\n\nThe following arguments are optional:\n" } }, "type": "object", "required": [ "statusCode" ] }, "aws:lb/ListenerMutualAuthentication:ListenerMutualAuthentication": { "properties": { "advertiseTrustStoreCaNames": { "type": "string", "description": "Valid values are `off` and `on`.\n" }, "ignoreClientCertificateExpiry": { "type": "boolean", "description": "Whether client certificate expiry is ignored. Default is `false`.\n" }, "mode": { "type": "string", "description": "Valid values are `off`, `verify` and `passthrough`.\n" }, "trustStoreArn": { "type": "string", "description": "ARN of the elbv2 Trust Store.\n" } }, "type": "object", "required": [ "mode" ], "language": { "nodejs": { "requiredOutputs": [ "advertiseTrustStoreCaNames", "mode" ] } } }, "aws:lb/ListenerRuleAction:ListenerRuleAction": { "properties": { "authenticateCognito": { "$ref": "#/types/aws:lb/ListenerRuleActionAuthenticateCognito:ListenerRuleActionAuthenticateCognito", "description": "Information for creating an authenticate action using Cognito. Required if `type` is `authenticate-cognito`.\n" }, "authenticateOidc": { "$ref": "#/types/aws:lb/ListenerRuleActionAuthenticateOidc:ListenerRuleActionAuthenticateOidc", "description": "Information for creating an authenticate action using OIDC. Required if `type` is `authenticate-oidc`.\n" }, "fixedResponse": { "$ref": "#/types/aws:lb/ListenerRuleActionFixedResponse:ListenerRuleActionFixedResponse", "description": "Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`.\n" }, "forward": { "$ref": "#/types/aws:lb/ListenerRuleActionForward:ListenerRuleActionForward", "description": "Configuration block for creating an action that distributes requests among one or more target groups.\nSpecify only if `type` is `forward`.\nCannot be specified with `target_group_arn`.\n" }, "order": { "type": "integer", "description": "Order for the action.\nThe action with the lowest value for order is performed first.\nValid values are between `1` and `50000`.\nDefaults to the position in the list of actions.\n" }, "redirect": { "$ref": "#/types/aws:lb/ListenerRuleActionRedirect:ListenerRuleActionRedirect", "description": "Information for creating a redirect action. Required if `type` is `redirect`.\n" }, "targetGroupArn": { "type": "string", "description": "ARN of the Target Group to which to route traffic.\nSpecify only if `type` is `forward` and you want to route to a single target group.\nTo route to one or more target groups, use a `forward` block instead.\nCannot be specified with `forward`.\n" }, "type": { "type": "string", "description": "The type of routing action. Valid values are `forward`, `redirect`, `fixed-response`, `authenticate-cognito` and `authenticate-oidc`.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "order", "type" ] } } }, "aws:lb/ListenerRuleActionAuthenticateCognito:ListenerRuleActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "The maximum duration of the authentication session, in seconds.\n" }, "userPoolArn": { "type": "string", "description": "The ARN of the Cognito user pool.\n" }, "userPoolClientId": { "type": "string", "description": "The ID of the Cognito user pool client.\n" }, "userPoolDomain": { "type": "string", "description": "The domain prefix or fully-qualified domain name of the Cognito user pool.\n" } }, "type": "object", "required": [ "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredOutputs": [ "onUnauthenticatedRequest", "userPoolArn", "userPoolClientId", "userPoolDomain" ] } } }, "aws:lb/ListenerRuleActionAuthenticateOidc:ListenerRuleActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters to include in the redirect request to the authorization endpoint. Max: 10.\n" }, "authorizationEndpoint": { "type": "string", "description": "The authorization endpoint of the IdP.\n" }, "clientId": { "type": "string", "description": "The OAuth 2.0 client identifier.\n" }, "clientSecret": { "type": "string", "description": "The OAuth 2.0 client secret.\n", "secret": true }, "issuer": { "type": "string", "description": "The OIDC issuer identifier of the IdP.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate`\n" }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP.\n" }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "The maximum duration of the authentication session, in seconds.\n" }, "tokenEndpoint": { "type": "string", "description": "The token endpoint of the IdP.\n" }, "userInfoEndpoint": { "type": "string", "description": "The user info endpoint of the IdP.\n" } }, "type": "object", "required": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredOutputs": [ "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "tokenEndpoint", "userInfoEndpoint" ] } } }, "aws:lb/ListenerRuleActionFixedResponse:ListenerRuleActionFixedResponse": { "properties": { "contentType": { "type": "string", "description": "The content type. Valid values are `text/plain`, `text/css`, `text/html`, `application/javascript` and `application/json`.\n" }, "messageBody": { "type": "string", "description": "The message body.\n" }, "statusCode": { "type": "string", "description": "The HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`.\n" } }, "type": "object", "required": [ "contentType" ], "language": { "nodejs": { "requiredOutputs": [ "contentType", "statusCode" ] } } }, "aws:lb/ListenerRuleActionForward:ListenerRuleActionForward": { "properties": { "stickiness": { "$ref": "#/types/aws:lb/ListenerRuleActionForwardStickiness:ListenerRuleActionForwardStickiness", "description": "The target group stickiness for the rule.\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:lb/ListenerRuleActionForwardTargetGroup:ListenerRuleActionForwardTargetGroup" }, "description": "One or more target group blocks.\n" } }, "type": "object", "required": [ "targetGroups" ] }, "aws:lb/ListenerRuleActionForwardStickiness:ListenerRuleActionForwardStickiness": { "properties": { "duration": { "type": "integer", "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).\n" }, "enabled": { "type": "boolean", "description": "Indicates whether target group stickiness is enabled.\n" } }, "type": "object", "required": [ "duration" ] }, "aws:lb/ListenerRuleActionForwardTargetGroup:ListenerRuleActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the target group.\n" }, "weight": { "type": "integer", "description": "The weight. The range is 0 to 999.\n" } }, "type": "object", "required": [ "arn" ] }, "aws:lb/ListenerRuleActionRedirect:ListenerRuleActionRedirect": { "properties": { "host": { "type": "string", "description": "The hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`.\n" }, "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}. Defaults to `/#{path}`.\n" }, "port": { "type": "string", "description": "The port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`.\n" }, "protocol": { "type": "string", "description": "The protocol. Valid values are `HTTP`, `HTTPS`, or `#{protocol}`. Defaults to `#{protocol}`.\n" }, "query": { "type": "string", "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\". Defaults to `#{query}`.\n" }, "statusCode": { "type": "string", "description": "The HTTP redirect code. The redirect is either permanent (`HTTP_301`) or temporary (`HTTP_302`).\n" } }, "type": "object", "required": [ "statusCode" ] }, "aws:lb/ListenerRuleCondition:ListenerRuleCondition": { "properties": { "hostHeader": { "$ref": "#/types/aws:lb/ListenerRuleConditionHostHeader:ListenerRuleConditionHostHeader", "description": "Contains a single `values` item which is a list of host header patterns to match. The maximum size of each pattern is 128 characters. Comparison is case insensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). Only one pattern needs to match for the condition to be satisfied.\n" }, "httpHeader": { "$ref": "#/types/aws:lb/ListenerRuleConditionHttpHeader:ListenerRuleConditionHttpHeader", "description": "HTTP headers to match. HTTP Header block fields documented below.\n" }, "httpRequestMethod": { "$ref": "#/types/aws:lb/ListenerRuleConditionHttpRequestMethod:ListenerRuleConditionHttpRequestMethod", "description": "Contains a single `values` item which is a list of HTTP request methods or verbs to match. Maximum size is 40 characters. Only allowed characters are A-Z, hyphen (-) and underscore (\\_). Comparison is case sensitive. Wildcards are not supported. Only one needs to match for the condition to be satisfied. AWS recommends that GET and HEAD requests are routed in the same way because the response to a HEAD request may be cached.\n" }, "pathPattern": { "$ref": "#/types/aws:lb/ListenerRuleConditionPathPattern:ListenerRuleConditionPathPattern", "description": "Contains a single `values` item which is a list of path patterns to match against the request URL. Maximum size of each pattern is 128 characters. Comparison is case sensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). Only one pattern needs to match for the condition to be satisfied. Path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use a `query_string` condition.\n" }, "queryStrings": { "type": "array", "items": { "$ref": "#/types/aws:lb/ListenerRuleConditionQueryString:ListenerRuleConditionQueryString" }, "description": "Query strings to match. Query String block fields documented below.\n" }, "sourceIp": { "$ref": "#/types/aws:lb/ListenerRuleConditionSourceIp:ListenerRuleConditionSourceIp", "description": "Contains a single `values` item which is a list of source IP CIDR notations to match. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. Condition is satisfied if the source IP address of the request matches one of the CIDR blocks. Condition is not satisfied by the addresses in the `X-Forwarded-For` header, use `http_header` condition instead.\n\n\u003e **NOTE::** Exactly one of `host_header`, `http_header`, `http_request_method`, `path_pattern`, `query_string` or `source_ip` must be set per condition.\n" } }, "type": "object" }, "aws:lb/ListenerRuleConditionHostHeader:ListenerRuleConditionHostHeader": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:lb/ListenerRuleConditionHttpHeader:ListenerRuleConditionHttpHeader": { "properties": { "httpHeaderName": { "type": "string", "description": "Name of HTTP header to search. The maximum size is 40 characters. Comparison is case insensitive. Only RFC7240 characters are supported. Wildcards are not supported. You cannot use HTTP header condition to specify the host header, use a `host-header` condition instead.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of header value patterns to match. Maximum size of each pattern is 128 characters. Comparison is case insensitive. Wildcard characters supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If the same header appears multiple times in the request they will be searched in order until a match is found. Only one pattern needs to match for the condition to be satisfied. To require that all of the strings are a match, create one condition block per string.\n" } }, "type": "object", "required": [ "httpHeaderName", "values" ] }, "aws:lb/ListenerRuleConditionHttpRequestMethod:ListenerRuleConditionHttpRequestMethod": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:lb/ListenerRuleConditionPathPattern:ListenerRuleConditionPathPattern": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:lb/ListenerRuleConditionQueryString:ListenerRuleConditionQueryString": { "properties": { "key": { "type": "string", "description": "Query string key pattern to match.\n" }, "value": { "type": "string", "description": "Query string value pattern to match.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lb/ListenerRuleConditionSourceIp:ListenerRuleConditionSourceIp": { "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "values" ] }, "aws:lb/LoadBalancerAccessLogs:LoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string", "description": "S3 bucket name to store the logs in.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `access_logs`. Defaults to `false`, even when `bucket` is specified.\n" }, "prefix": { "type": "string", "description": "S3 bucket prefix. Logs are stored in the root if not configured.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:lb/LoadBalancerConnectionLogs:LoadBalancerConnectionLogs": { "properties": { "bucket": { "type": "string", "description": "S3 bucket name to store the logs in.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `connection_logs`. Defaults to `false`, even when `bucket` is specified.\n" }, "prefix": { "type": "string", "description": "S3 bucket prefix. Logs are stored in the root if not configured.\n" } }, "type": "object", "required": [ "bucket" ] }, "aws:lb/LoadBalancerIpamPools:LoadBalancerIpamPools": { "properties": { "ipv4IpamPoolId": { "type": "string", "description": "The ID of the IPv4 IPAM pool.\n" } }, "type": "object", "required": [ "ipv4IpamPoolId" ] }, "aws:lb/LoadBalancerSubnetMapping:LoadBalancerSubnetMapping": { "properties": { "allocationId": { "type": "string", "description": "Allocation ID of the Elastic IP address for an internet-facing load balancer.\n" }, "ipv6Address": { "type": "string", "description": "IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.\n" }, "outpostId": { "type": "string" }, "privateIpv4Address": { "type": "string", "description": "Private IPv4 address for an internal load balancer.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "outpostId", "subnetId" ] } } }, "aws:lb/TargetGroupHealthCheck:TargetGroupHealthCheck": { "properties": { "enabled": { "type": "boolean", "description": "Whether health checks are enabled. Defaults to `true`.\n" }, "healthyThreshold": { "type": "integer", "description": "Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.\n" }, "interval": { "type": "integer", "description": "Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For `lambda` target groups, it needs to be greater than the timeout of the underlying `lambda`. Defaults to 30.\n" }, "matcher": { "type": "string", "description": "The HTTP or gRPC codes to use when checking for a successful response from a target.\nThe `health_check.protocol` must be one of `HTTP` or `HTTPS` or the `target_type` must be `lambda`.\nValues can be comma-separated individual values (e.g., \"200,202\") or a range of values (e.g., \"200-299\").\n* For gRPC-based target groups (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is `GRPC`), values can be between `0` and `99`. The default is `12`.\n* When used with an Application Load Balancer (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is not `GRPC`), values can be between `200` and `499`. The default is `200`.\n* When used with a Network Load Balancer (i.e., the `protocol` is one of `TCP`, `TCP_UDP`, `UDP`, or `TLS`), values can be between `200` and `599`. The default is `200-399`.\n* When the `target_type` is `lambda`, values can be between `200` and `499`. The default is `200`.\n" }, "path": { "type": "string", "description": "Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.\n* For HTTP and HTTPS health checks, the default is `/`.\n* For gRPC health checks, the default is `/AWS.ALB/healthcheck`.\n" }, "port": { "type": "string", "description": "The port the load balancer uses when performing health checks on targets.\nValid values are either `traffic-port`, to use the same port as the target group, or a valid port number between `1` and `65536`.\nDefault is `traffic-port`.\n" }, "protocol": { "type": "string", "description": "Protocol the load balancer uses when performing health checks on targets.\nMust be one of `TCP`, `HTTP`, or `HTTPS`.\nThe `TCP` protocol is not supported for health checks if the protocol of the target group is `HTTP` or `HTTPS`.\nDefault is `HTTP`.\nCannot be specified when the `target_type` is `lambda`.\n" }, "timeout": { "type": "integer", "description": "Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "matcher", "path", "timeout" ] } } }, "aws:lb/TargetGroupStickiness:TargetGroupStickiness": { "properties": { "cookieDuration": { "type": "integer", "description": "Only used when the type is `lb_cookie`. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).\n" }, "cookieName": { "type": "string", "description": "Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is `app_cookie`.\n" }, "enabled": { "type": "boolean", "description": "Boolean to enable / disable `stickiness`. Default is `true`.\n" }, "type": { "type": "string", "description": "The type of sticky sessions. The only current possible values are `lb_cookie`, `app_cookie` for ALBs, `source_ip` for NLBs, and `source_ip_dest_ip`, `source_ip_dest_ip_proto` for GWLBs.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lb/TargetGroupTargetFailover:TargetGroupTargetFailover": { "properties": { "onDeregistration": { "type": "string", "description": "Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are `rebalance` and `no_rebalance`. Must match the attribute value set for `on_unhealthy`. Default: `no_rebalance`.\n" }, "onUnhealthy": { "type": "string", "description": "Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are `rebalance` and `no_rebalance`. Must match the attribute value set for `on_deregistration`. Default: `no_rebalance`.\n" } }, "type": "object", "required": [ "onDeregistration", "onUnhealthy" ] }, "aws:lb/TargetGroupTargetGroupHealth:TargetGroupTargetGroupHealth": { "properties": { "dnsFailover": { "$ref": "#/types/aws:lb/TargetGroupTargetGroupHealthDnsFailover:TargetGroupTargetGroupHealthDnsFailover", "description": "Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.\n" }, "unhealthyStateRouting": { "$ref": "#/types/aws:lb/TargetGroupTargetGroupHealthUnhealthyStateRouting:TargetGroupTargetGroupHealthUnhealthyStateRouting", "description": "Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.\n" } }, "type": "object" }, "aws:lb/TargetGroupTargetGroupHealthDnsFailover:TargetGroupTargetGroupHealthDnsFailover": { "properties": { "minimumHealthyTargetsCount": { "type": "string", "description": "The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are `off` or an integer from `1` to the maximum number of targets. The default is `off`.\n" }, "minimumHealthyTargetsPercentage": { "type": "string", "description": "The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are `off` or an integer from `1` to `100`. The default is `off`.\n" } }, "type": "object" }, "aws:lb/TargetGroupTargetGroupHealthUnhealthyStateRouting:TargetGroupTargetGroupHealthUnhealthyStateRouting": { "properties": { "minimumHealthyTargetsCount": { "type": "integer", "description": "The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are `1` to the maximum number of targets. The default is `1`.\n" }, "minimumHealthyTargetsPercentage": { "type": "string", "description": "The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are `off` or an integer from `1` to `100`. The default is `off`.\n" } }, "type": "object" }, "aws:lb/TargetGroupTargetHealthState:TargetGroupTargetHealthState": { "properties": { "enableUnhealthyConnectionTermination": { "type": "boolean", "description": "Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are `true` or `false`. Default: `true`.\n" }, "unhealthyDrainingInterval": { "type": "integer", "description": "Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is `0-360000`. This value has to be set only if `enable_unhealthy_connection_termination` is set to false. Default: `0`.\n" } }, "type": "object", "required": [ "enableUnhealthyConnectionTermination" ] }, "aws:lb/getListenerDefaultAction:getListenerDefaultAction": { "properties": { "authenticateCognitos": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionAuthenticateCognito:getListenerDefaultActionAuthenticateCognito" } }, "authenticateOidcs": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionAuthenticateOidc:getListenerDefaultActionAuthenticateOidc" } }, "fixedResponses": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionFixedResponse:getListenerDefaultActionFixedResponse" } }, "forwards": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionForward:getListenerDefaultActionForward" } }, "order": { "type": "integer" }, "redirects": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionRedirect:getListenerDefaultActionRedirect" } }, "targetGroupArn": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "required": [ "authenticateCognitos", "authenticateOidcs", "fixedResponses", "forwards", "order", "redirects", "targetGroupArn", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionAuthenticateCognito:getListenerDefaultActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" } }, "onUnauthenticatedRequest": { "type": "string" }, "scope": { "type": "string" }, "sessionCookieName": { "type": "string" }, "sessionTimeout": { "type": "integer" }, "userPoolArn": { "type": "string" }, "userPoolClientId": { "type": "string" }, "userPoolDomain": { "type": "string" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionAuthenticateOidc:getListenerDefaultActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" } }, "authorizationEndpoint": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "issuer": { "type": "string" }, "onUnauthenticatedRequest": { "type": "string" }, "scope": { "type": "string" }, "sessionCookieName": { "type": "string" }, "sessionTimeout": { "type": "integer" }, "tokenEndpoint": { "type": "string" }, "userInfoEndpoint": { "type": "string" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "authorizationEndpoint", "clientId", "clientSecret", "issuer", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionFixedResponse:getListenerDefaultActionFixedResponse": { "properties": { "contentType": { "type": "string" }, "messageBody": { "type": "string" }, "statusCode": { "type": "string" } }, "type": "object", "required": [ "contentType", "messageBody", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionForward:getListenerDefaultActionForward": { "properties": { "stickinesses": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionForwardStickiness:getListenerDefaultActionForwardStickiness" } }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerDefaultActionForwardTargetGroup:getListenerDefaultActionForwardTargetGroup" } } }, "type": "object", "required": [ "stickinesses", "targetGroups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionForwardStickiness:getListenerDefaultActionForwardStickiness": { "properties": { "duration": { "type": "integer" }, "enabled": { "type": "boolean" } }, "type": "object", "required": [ "duration", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionForwardTargetGroup:getListenerDefaultActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the listener. Required if `load_balancer_arn` and `port` is not set.\n" }, "weight": { "type": "integer" } }, "type": "object", "required": [ "arn", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerDefaultActionRedirect:getListenerDefaultActionRedirect": { "properties": { "host": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "string", "description": "Port of the listener. Required if `arn` is not set.\n" }, "protocol": { "type": "string" }, "query": { "type": "string" }, "statusCode": { "type": "string" } }, "type": "object", "required": [ "host", "path", "port", "protocol", "query", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerMutualAuthentication:getListenerMutualAuthentication": { "properties": { "advertiseTrustStoreCaNames": { "type": "string" }, "ignoreClientCertificateExpiry": { "type": "boolean" }, "mode": { "type": "string" }, "trustStoreArn": { "type": "string" } }, "type": "object", "required": [ "advertiseTrustStoreCaNames", "ignoreClientCertificateExpiry", "mode", "trustStoreArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleAction:getListenerRuleAction": { "properties": { "authenticateCognito": { "$ref": "#/types/aws:lb/getListenerRuleActionAuthenticateCognito:getListenerRuleActionAuthenticateCognito", "description": "An action to authenticate using Amazon Cognito.\nDetailed below.\n" }, "authenticateOidc": { "$ref": "#/types/aws:lb/getListenerRuleActionAuthenticateOidc:getListenerRuleActionAuthenticateOidc", "description": "An action to authenticate using OIDC.\nDetailed below.\n" }, "fixedResponse": { "$ref": "#/types/aws:lb/getListenerRuleActionFixedResponse:getListenerRuleActionFixedResponse", "description": "An action to return a fixed response.\nDetailed below.\n" }, "forward": { "$ref": "#/types/aws:lb/getListenerRuleActionForward:getListenerRuleActionForward", "description": "An action to forward the request.\nDetailed below.\n" }, "order": { "type": "integer", "description": "The evaluation order of the action.\n" }, "redirect": { "$ref": "#/types/aws:lb/getListenerRuleActionRedirect:getListenerRuleActionRedirect", "description": "An action to redirect the request.\nDetailed below.\n" }, "type": { "type": "string", "description": "The type of the action, indicates which sub-block will be populated.\n" } }, "type": "object", "required": [ "order", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionAuthenticateCognito:getListenerRuleActionAuthenticateCognito": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Set of additional parameters for the request.\nDetailed below.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior when the client is not authenticated.\n" }, "scope": { "type": "string", "description": "Set of user claims requested.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session in seconds.\n" }, "userPoolArn": { "type": "string", "description": "ARN of the Cognito user pool.\n" }, "userPoolClientId": { "type": "string", "description": "ID of the Cognito user pool client.\n" }, "userPoolDomain": { "type": "string", "description": "Domain prefix or fully-qualified domain name of the Cognito user pool.\n" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "userPoolArn", "userPoolClientId", "userPoolDomain" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionAuthenticateOidc:getListenerRuleActionAuthenticateOidc": { "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Set of additional parameters for the request.\nDetailed below.\n" }, "authorizationEndpoint": { "type": "string", "description": "The authorization endpoint of the IdP.\n" }, "clientId": { "type": "string", "description": "OAuth 2.0 client identifier.\n" }, "issuer": { "type": "string", "description": "OIDC issuer identifier of the IdP.\n" }, "onUnauthenticatedRequest": { "type": "string", "description": "Behavior when the client is not authenticated.\n" }, "scope": { "type": "string", "description": "Set of user claims requested.\n" }, "sessionCookieName": { "type": "string", "description": "Name of the cookie used to maintain session information.\n" }, "sessionTimeout": { "type": "integer", "description": "Maximum duration of the authentication session in seconds.\n" }, "tokenEndpoint": { "type": "string", "description": "The token endpoint of the IdP.\n" }, "userInfoEndpoint": { "type": "string", "description": "The user info endpoint of the IdP.\n" } }, "type": "object", "required": [ "authenticationRequestExtraParams", "authorizationEndpoint", "clientId", "issuer", "onUnauthenticatedRequest", "scope", "sessionCookieName", "sessionTimeout", "tokenEndpoint", "userInfoEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionFixedResponse:getListenerRuleActionFixedResponse": { "properties": { "contentType": { "type": "string", "description": "Content type of the response.\n" }, "messageBody": { "type": "string", "description": "Message body of the response.\n" }, "statusCode": { "type": "string", "description": "The HTTP redirect code.\n" } }, "type": "object", "required": [ "contentType", "messageBody", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionForward:getListenerRuleActionForward": { "properties": { "stickiness": { "$ref": "#/types/aws:lb/getListenerRuleActionForwardStickiness:getListenerRuleActionForwardStickiness", "description": "Target group stickiness for the rule.\nDetailed below.\n" }, "targetGroups": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerRuleActionForwardTargetGroup:getListenerRuleActionForwardTargetGroup" }, "description": "Set of target groups for the action.\nDetailed below.\n" } }, "type": "object" }, "aws:lb/getListenerRuleActionForwardStickiness:getListenerRuleActionForwardStickiness": { "properties": { "duration": { "type": "integer", "description": "The time period, in seconds, during which requests from a client should be routed to the same target group.\n" }, "enabled": { "type": "boolean", "description": "Indicates whether target group stickiness is enabled.\n" } }, "type": "object", "required": [ "duration", "enabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionForwardTargetGroup:getListenerRuleActionForwardTargetGroup": { "properties": { "arn": { "type": "string", "description": "ARN of the Listener Rule.\nEither `arn` or `listener_arn` must be set.\n" }, "weight": { "type": "integer", "description": "Weight of the target group.\n" } }, "type": "object", "required": [ "arn", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleActionRedirect:getListenerRuleActionRedirect": { "properties": { "host": { "type": "string", "description": "The hostname.\n" }, "path": { "type": "string", "description": "The absolute path, starting with `/`.\n" }, "port": { "type": "string", "description": "The port.\n" }, "protocol": { "type": "string", "description": "The protocol.\n" }, "query": { "type": "string", "description": "The query parameters.\n" }, "statusCode": { "type": "string", "description": "The HTTP redirect code.\n" } }, "type": "object", "required": [ "host", "path", "port", "protocol", "query", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleCondition:getListenerRuleCondition": { "properties": { "hostHeader": { "$ref": "#/types/aws:lb/getListenerRuleConditionHostHeader:getListenerRuleConditionHostHeader", "description": "Contains a single attribute `values`, which contains a set of host names.\n" }, "httpHeader": { "$ref": "#/types/aws:lb/getListenerRuleConditionHttpHeader:getListenerRuleConditionHttpHeader", "description": "HTTP header and values to match.\nDetailed below.\n" }, "httpRequestMethod": { "$ref": "#/types/aws:lb/getListenerRuleConditionHttpRequestMethod:getListenerRuleConditionHttpRequestMethod", "description": "Contains a single attribute `values`, which contains a set of HTTP request methods.\n" }, "pathPattern": { "$ref": "#/types/aws:lb/getListenerRuleConditionPathPattern:getListenerRuleConditionPathPattern", "description": "Contains a single attribute `values`, which contains a set of path patterns to compare against the request URL.\n" }, "queryString": { "$ref": "#/types/aws:lb/getListenerRuleConditionQueryString:getListenerRuleConditionQueryString", "description": "Query string parameters to match.\nDetailed below.\n" }, "sourceIp": { "$ref": "#/types/aws:lb/getListenerRuleConditionSourceIp:getListenerRuleConditionSourceIp", "description": "Contains a single attribute `values`, which contains a set of source IPs in CIDR notation.\n" } }, "type": "object" }, "aws:lb/getListenerRuleConditionHostHeader:getListenerRuleConditionHostHeader": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleConditionHttpHeader:getListenerRuleConditionHttpHeader": { "properties": { "httpHeaderName": { "type": "string", "description": "Name of the HTTP header to match.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object", "required": [ "httpHeaderName", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleConditionHttpRequestMethod:getListenerRuleConditionHttpRequestMethod": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleConditionPathPattern:getListenerRuleConditionPathPattern": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleConditionQueryString:getListenerRuleConditionQueryString": { "properties": { "values": { "type": "array", "items": { "$ref": "#/types/aws:lb/getListenerRuleConditionQueryStringValue:getListenerRuleConditionQueryStringValue" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object" }, "aws:lb/getListenerRuleConditionQueryStringValue:getListenerRuleConditionQueryStringValue": { "properties": { "key": { "type": "string", "description": "Key of query parameter\n" }, "value": { "type": "string", "description": "Value of query parameter\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getListenerRuleConditionSourceIp:getListenerRuleConditionSourceIp": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Set of `key`-`value` pairs indicating the query string parameters to match.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getLoadBalancerAccessLogs:getLoadBalancerAccessLogs": { "properties": { "bucket": { "type": "string" }, "enabled": { "type": "boolean" }, "prefix": { "type": "string" } }, "type": "object", "required": [ "bucket", "enabled", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getLoadBalancerConnectionLog:getLoadBalancerConnectionLog": { "properties": { "bucket": { "type": "string" }, "enabled": { "type": "boolean" }, "prefix": { "type": "string" } }, "type": "object", "required": [ "bucket", "enabled", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getLoadBalancerIpamPool:getLoadBalancerIpamPool": { "properties": { "ipv4IpamPoolId": { "type": "string" } }, "type": "object", "required": [ "ipv4IpamPoolId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getLoadBalancerSubnetMapping:getLoadBalancerSubnetMapping": { "properties": { "allocationId": { "type": "string" }, "ipv6Address": { "type": "string" }, "outpostId": { "type": "string" }, "privateIpv4Address": { "type": "string" }, "subnetId": { "type": "string" } }, "type": "object", "required": [ "allocationId", "ipv6Address", "outpostId", "privateIpv4Address", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getTargetGroupHealthCheck:getTargetGroupHealthCheck": { "properties": { "enabled": { "type": "boolean" }, "healthyThreshold": { "type": "integer" }, "interval": { "type": "integer" }, "matcher": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "string" }, "protocol": { "type": "string" }, "timeout": { "type": "integer" }, "unhealthyThreshold": { "type": "integer" } }, "type": "object", "required": [ "enabled", "healthyThreshold", "interval", "matcher", "path", "port", "protocol", "timeout", "unhealthyThreshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lb/getTargetGroupStickiness:getTargetGroupStickiness": { "properties": { "cookieDuration": { "type": "integer" }, "cookieName": { "type": "string" }, "enabled": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object", "required": [ "cookieDuration", "cookieName", "enabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "aws:lex/BotAbortStatement:BotAbortStatement": { "properties": { "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/BotAbortStatementMessage:BotAbortStatementMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "messages" ] }, "aws:lex/BotAbortStatementMessage:BotAbortStatementMessage": { "properties": { "content": { "type": "string", "description": "The text of the message.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response.\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/BotAliasConversationLogs:BotAliasConversationLogs": { "properties": { "iamRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket. Must be between 20 and 2048 characters in length.\n" }, "logSettings": { "type": "array", "items": { "$ref": "#/types/aws:lex/BotAliasConversationLogsLogSetting:BotAliasConversationLogsLogSetting" }, "description": "The settings for your conversation logs. You can log text, audio, or both. Attributes are documented under log_settings.\n" } }, "type": "object", "required": [ "iamRoleArn" ] }, "aws:lex/BotAliasConversationLogsLogSetting:BotAliasConversationLogsLogSetting": { "properties": { "destination": { "type": "string", "description": "The destination where logs are delivered. Options are `CLOUDWATCH_LOGS` or `S3`.\n" }, "kmsKeyArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket. This can only be specified when `destination` is set to `S3`. Must be between 20 and 2048 characters in length.\n" }, "logType": { "type": "string", "description": "The type of logging that is enabled. Options are `AUDIO` or `TEXT`.\n" }, "resourceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered. Must be less than or equal to 2048 characters in length.\n" }, "resourcePrefix": { "type": "string", "description": "The prefix of the S3 object key for `AUDIO` logs or the log stream name for `TEXT` logs.\n" } }, "type": "object", "required": [ "destination", "logType", "resourceArn" ], "language": { "nodejs": { "requiredOutputs": [ "destination", "logType", "resourceArn", "resourcePrefix" ] } } }, "aws:lex/BotClarificationPrompt:BotClarificationPrompt": { "properties": { "maxAttempts": { "type": "integer", "description": "The number of times to prompt the user for information.\n" }, "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/BotClarificationPromptMessage:BotClarificationPromptMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "maxAttempts", "messages" ] }, "aws:lex/BotClarificationPromptMessage:BotClarificationPromptMessage": { "properties": { "content": { "type": "string", "description": "The text of the message.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response.\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/BotIntent:BotIntent": { "properties": { "intentName": { "type": "string", "description": "The name of the intent. Must be less than or equal to 100 characters in length.\n" }, "intentVersion": { "type": "string", "description": "The version of the intent. Must be less than or equal to 64 characters in length.\n" } }, "type": "object", "required": [ "intentName", "intentVersion" ] }, "aws:lex/IntentConclusionStatement:IntentConclusionStatement": { "properties": { "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentConclusionStatementMessage:IntentConclusionStatementMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "messages" ] }, "aws:lex/IntentConclusionStatementMessage:IntentConclusionStatementMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/IntentConfirmationPrompt:IntentConfirmationPrompt": { "properties": { "maxAttempts": { "type": "integer", "description": "The number of times to prompt the user for information. Must be a number between 1 and 5 (inclusive).\n" }, "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentConfirmationPromptMessage:IntentConfirmationPromptMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "maxAttempts", "messages" ] }, "aws:lex/IntentConfirmationPromptMessage:IntentConfirmationPromptMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/IntentDialogCodeHook:IntentDialogCodeHook": { "properties": { "messageVersion": { "type": "string", "description": "The version of the request-response that you want Amazon Lex to use\nto invoke your Lambda function. For more information, see\n[Using Lambda Functions](https://docs.aws.amazon.com/lex/latest/dg/using-lambda.html). Must be less than or equal to 5 characters in length.\n" }, "uri": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Lambda function.\n" } }, "type": "object", "required": [ "messageVersion", "uri" ] }, "aws:lex/IntentFollowUpPrompt:IntentFollowUpPrompt": { "properties": { "prompt": { "$ref": "#/types/aws:lex/IntentFollowUpPromptPrompt:IntentFollowUpPromptPrompt", "description": "Prompts for information from the user. Attributes are documented under prompt.\n" }, "rejectionStatement": { "$ref": "#/types/aws:lex/IntentFollowUpPromptRejectionStatement:IntentFollowUpPromptRejectionStatement", "description": "If the user answers \"no\" to the question defined in the prompt field,\nAmazon Lex responds with this statement to acknowledge that the intent was canceled. Attributes are\ndocumented below under statement.\n" } }, "type": "object", "required": [ "prompt", "rejectionStatement" ] }, "aws:lex/IntentFollowUpPromptPrompt:IntentFollowUpPromptPrompt": { "properties": { "maxAttempts": { "type": "integer", "description": "The number of times to prompt the user for information. Must be a number between 1 and 5 (inclusive).\n" }, "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentFollowUpPromptPromptMessage:IntentFollowUpPromptPromptMessage" }, "description": "A set of messages, each of which provides a message string and its type.\nYou can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).\nAttributes are documented under message. Must contain between 1 and 15 messages.\n" }, "responseCard": { "type": "string", "description": "The response card. Amazon Lex will substitute session attributes and\nslot values into the response card. For more information, see\n[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html). Must be less than or equal to 50000 characters in length.\n" } }, "type": "object", "required": [ "maxAttempts", "messages" ] }, "aws:lex/IntentFollowUpPromptPromptMessage:IntentFollowUpPromptPromptMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/IntentFollowUpPromptRejectionStatement:IntentFollowUpPromptRejectionStatement": { "properties": { "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentFollowUpPromptRejectionStatementMessage:IntentFollowUpPromptRejectionStatementMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "messages" ] }, "aws:lex/IntentFollowUpPromptRejectionStatementMessage:IntentFollowUpPromptRejectionStatementMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/IntentFulfillmentActivity:IntentFulfillmentActivity": { "properties": { "codeHook": { "$ref": "#/types/aws:lex/IntentFulfillmentActivityCodeHook:IntentFulfillmentActivityCodeHook", "description": "A description of the Lambda function that is run to fulfill the intent.\nRequired if type is CodeHook. Attributes are documented under code_hook.\n" }, "type": { "type": "string", "description": "How the intent should be fulfilled, either by running a Lambda function or by\nreturning the slot data to the client application. Type can be either `ReturnIntent` or `CodeHook`, as documented [here](https://docs.aws.amazon.com/lex/latest/dg/API_FulfillmentActivity.html).\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/IntentFulfillmentActivityCodeHook:IntentFulfillmentActivityCodeHook": { "properties": { "messageVersion": { "type": "string", "description": "The version of the request-response that you want Amazon Lex to use\nto invoke your Lambda function. For more information, see\n[Using Lambda Functions](https://docs.aws.amazon.com/lex/latest/dg/using-lambda.html). Must be less than or equal to 5 characters in length.\n" }, "uri": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Lambda function.\n" } }, "type": "object", "required": [ "messageVersion", "uri" ] }, "aws:lex/IntentRejectionStatement:IntentRejectionStatement": { "properties": { "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentRejectionStatementMessage:IntentRejectionStatementMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "messages" ] }, "aws:lex/IntentRejectionStatementMessage:IntentRejectionStatementMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/IntentSlot:IntentSlot": { "properties": { "description": { "type": "string", "description": "A description of the bot. Must be less than or equal to 200 characters in length.\n" }, "name": { "type": "string", "description": "The name of the intent slot that you want to create. The name is case sensitive. Must be less than or equal to 100 characters in length.\n" }, "priority": { "type": "integer", "description": "Directs Lex the order in which to elicit this slot value from the user.\nFor example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for\nthe slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits\nvalues is arbitrary. Must be between 1 and 100.\n" }, "responseCard": { "type": "string", "description": "The response card. Amazon Lex will substitute session attributes and\nslot values into the response card. For more information, see\n[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html). Must be less than or equal to 50000 characters in length.\n" }, "sampleUtterances": { "type": "array", "items": { "type": "string" }, "description": "If you know a specific pattern with which users might respond to\nan Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This\nis optional. In most cases, Amazon Lex is capable of understanding user utterances. Must have between 1 and 10 items in the list, and each item must be less than or equal to 200 characters in length.\n" }, "slotConstraint": { "type": "string", "description": "Specifies whether the slot is required or optional.\n" }, "slotType": { "type": "string", "description": "The type of the slot, either a custom slot type that you defined or one of\nthe built-in slot types. Must be less than or equal to 100 characters in length.\n" }, "slotTypeVersion": { "type": "string", "description": "The version of the slot type. Must be less than or equal to 64 characters in length.\n" }, "valueElicitationPrompt": { "$ref": "#/types/aws:lex/IntentSlotValueElicitationPrompt:IntentSlotValueElicitationPrompt", "description": "The prompt that Amazon Lex uses to elicit the slot value\nfrom the user. Attributes are documented under prompt.\n" } }, "type": "object", "required": [ "name", "slotConstraint", "slotType" ] }, "aws:lex/IntentSlotValueElicitationPrompt:IntentSlotValueElicitationPrompt": { "properties": { "maxAttempts": { "type": "integer", "description": "The number of times to prompt the user for information. Must be a number between 1 and 5 (inclusive).\n" }, "messages": { "type": "array", "items": { "$ref": "#/types/aws:lex/IntentSlotValueElicitationPromptMessage:IntentSlotValueElicitationPromptMessage" } }, "responseCard": { "type": "string" } }, "type": "object", "required": [ "maxAttempts", "messages" ] }, "aws:lex/IntentSlotValueElicitationPromptMessage:IntentSlotValueElicitationPromptMessage": { "properties": { "content": { "type": "string", "description": "The text of the message. Must be less than or equal to 1000 characters in length.\n" }, "contentType": { "type": "string", "description": "The content type of the message string.\n" }, "groupNumber": { "type": "integer", "description": "Identifies the message group that the message belongs to. When a group\nis assigned to a message, Amazon Lex returns one message from each group in the response. Must be a number between 1 and 5 (inclusive).\n" } }, "type": "object", "required": [ "content", "contentType" ] }, "aws:lex/SlotTypeEnumerationValue:SlotTypeEnumerationValue": { "properties": { "synonyms": { "type": "array", "items": { "type": "string" }, "description": "Additional values related to the slot type value. Each item must be less than or equal to 140 characters in length.\n" }, "value": { "type": "string", "description": "The value of the slot type. Must be less than or equal to 140 characters in length.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsBotDataPrivacy:V2modelsBotDataPrivacy": { "properties": { "childDirected": { "type": "boolean", "description": "(Required) - 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.\n" } }, "type": "object", "required": [ "childDirected" ] }, "aws:lex/V2modelsBotLocaleTimeouts:V2modelsBotLocaleTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:lex/V2modelsBotLocaleVoiceSettings:V2modelsBotLocaleVoiceSettings": { "properties": { "engine": { "type": "string", "description": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. Valid values are `standard` and `neural`. If not specified, the default is `standard`.\n" }, "voiceId": { "type": "string", "description": "Identifier of the Amazon Polly voice to use.\n" } }, "type": "object", "required": [ "voiceId" ], "language": { "nodejs": { "requiredOutputs": [ "engine", "voiceId" ] } } }, "aws:lex/V2modelsBotMember:V2modelsBotMember": { "properties": { "aliasId": { "type": "string", "description": "(Required) - Alias ID of a bot that is a member of this network of bots.\n" }, "aliasName": { "type": "string", "description": "(Required) - Alias name of a bot that is a member of this network of bots.\n" }, "id": { "type": "string", "description": "(Required) - Unique ID of a bot that is a member of this network of bots.\n" }, "name": { "type": "string", "description": "Name of the bot. The bot name must be unique in the account that creates the bot. Type String. Length Constraints: Minimum length of 1. Maximum length of 100.\n" }, "version": { "type": "string", "description": "(Required) - Version of a bot that is a member of this network of bots.\n" } }, "type": "object", "required": [ "aliasId", "aliasName", "id", "name", "version" ] }, "aws:lex/V2modelsBotTimeouts:V2modelsBotTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" }, "update": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" } }, "type": "object" }, "aws:lex/V2modelsBotVersionLocaleSpecification:V2modelsBotVersionLocaleSpecification": { "properties": { "sourceBotVersion": { "type": "string" } }, "type": "object", "required": [ "sourceBotVersion" ] }, "aws:lex/V2modelsBotVersionTimeouts:V2modelsBotVersionTimeouts": { "properties": { "create": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours).\n" }, "delete": { "type": "string", "description": "A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as \"30s\" or \"2h45m\". Valid time units are \"s\" (seconds), \"m\" (minutes), \"h\" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSetting:V2modelsIntentClosingSetting": { "properties": { "active": { "type": "boolean", "description": "Whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.\n" }, "closingResponse": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponse:V2modelsIntentClosingSettingClosingResponse", "description": "Configuration block for response that Amazon Lex sends to the user when the intent is complete. See `closing_response`.\n" }, "conditional": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditional:V2modelsIntentClosingSettingConditional", "description": "Configuration block for list of conditional branches associated with the intent's closing response. These branches are executed when the `next_step` attribute is set to `EvalutateConditional`. See `conditional`.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingNextStep:V2modelsIntentClosingSettingNextStep", "description": "Next step that the bot executes after playing the intent's closing response. See `next_step`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingClosingResponse:V2modelsIntentClosingSettingClosingResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroup:V2modelsIntentClosingSettingClosingResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroup:V2modelsIntentClosingSettingClosingResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariation:V2modelsIntentClosingSettingClosingResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariation:V2modelsIntentClosingSettingClosingResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingClosingResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingClosingResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditional:V2modelsIntentClosingSettingConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranch:V2modelsIntentClosingSettingConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranch:V2modelsIntentClosingSettingConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranch:V2modelsIntentClosingSettingConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchCondition:V2modelsIntentClosingSettingConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStep:V2modelsIntentClosingSettingConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponse:V2modelsIntentClosingSettingConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchCondition:V2modelsIntentClosingSettingConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStep:V2modelsIntentClosingSettingConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepDialogAction:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntent:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepDialogAction:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntent:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentClosingSettingConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponse:V2modelsIntentClosingSettingConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroup:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroup:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranch:V2modelsIntentClosingSettingConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStep:V2modelsIntentClosingSettingConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponse:V2modelsIntentClosingSettingConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStep:V2modelsIntentClosingSettingConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepDialogAction:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntent:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepDialogAction:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntent:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentClosingSettingConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponse:V2modelsIntentClosingSettingConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroup:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroup:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentClosingSettingConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentClosingSettingNextStep:V2modelsIntentClosingSettingNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingNextStepDialogAction:V2modelsIntentClosingSettingNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingNextStepIntent:V2modelsIntentClosingSettingNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingNextStepDialogAction:V2modelsIntentClosingSettingNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentClosingSettingNextStepIntent:V2modelsIntentClosingSettingNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingNextStepIntentSlot:V2modelsIntentClosingSettingNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentClosingSettingNextStepIntentSlot:V2modelsIntentClosingSettingNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentClosingSettingNextStepIntentSlotValue:V2modelsIntentClosingSettingNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentClosingSettingNextStepIntentSlotValue:V2modelsIntentClosingSettingNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSetting:V2modelsIntentConfirmationSetting": { "properties": { "active": { "type": "boolean", "description": "Whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.\n" }, "codeHook": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHook:V2modelsIntentConfirmationSettingCodeHook", "description": "Configuration block for the 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 `invoke_dialog_code_hook`. See `code_hook`.\n" }, "confirmationConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditional:V2modelsIntentConfirmationSettingConfirmationConditional", "description": "Configuration block for conditional branches to evaluate after the intent is closed. See `confirmation_conditional`.\n" }, "confirmationNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStep:V2modelsIntentConfirmationSettingConfirmationNextStep", "description": "Configuration block for the next step that the bot executes when the customer confirms the intent. See `confirmation_next_step`.\n" }, "confirmationResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponse:V2modelsIntentConfirmationSettingConfirmationResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `confirmation_response`.\n" }, "declinationConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditional:V2modelsIntentConfirmationSettingDeclinationConditional", "description": "Configuration block for conditional branches to evaluate after the intent is declined. See `declination_conditional`.\n" }, "declinationNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStep:V2modelsIntentConfirmationSettingDeclinationNextStep", "description": "Configuration block for the next step that the bot executes when the customer declines the intent. See `declination_next_step`.\n" }, "declinationResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponse:V2modelsIntentConfirmationSettingDeclinationResponse", "description": "Configuration block for when the user answers \"no\" to the question defined in `prompt_specification`, Amazon Lex responds with this response to acknowledge that the intent was canceled. See `declination_response`.\n" }, "elicitationCodeHook": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingElicitationCodeHook:V2modelsIntentConfirmationSettingElicitationCodeHook", "description": "Configuration block for when the code hook is invoked during confirmation prompt retries. See `elicitation_code_hook`.\n" }, "failureConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditional:V2modelsIntentConfirmationSettingFailureConditional", "description": "Configuration block for 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. See `failure_conditional`.\n" }, "failureNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureNextStep:V2modelsIntentConfirmationSettingFailureNextStep", "description": "Configuration block for the next step to take in the conversation if the confirmation step fails. See `failure_next_step`.\n" }, "failureResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponse:V2modelsIntentConfirmationSettingFailureResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `failure_response`.\n" }, "promptSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecification:V2modelsIntentConfirmationSettingPromptSpecification", "description": "Configuration block for prompting the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. See `prompt_specification`.\n" } }, "type": "object", "required": [ "promptSpecification" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHook:V2modelsIntentConfirmationSettingCodeHook": { "properties": { "active": { "type": "boolean", "description": "Whether a dialog code hook is used when the intent is activated.\n" }, "enableCodeHookInvocation": { "type": "boolean", "description": "Whether a Lambda function should be invoked for the dialog.\n" }, "invocationLabel": { "type": "string", "description": "Label that indicates the dialog step from which the dialog code hook is happening.\n" }, "postCodeHookSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecification:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecification", "description": "Configuration block that contains the responses and actions that Amazon Lex takes after the Lambda function is complete. See `post_code_hook_specification`.\n" } }, "type": "object", "required": [ "active", "enableCodeHookInvocation", "postCodeHookSpecification" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecification:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecification": { "properties": { "failureConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditional", "description": "Configuration block for 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.\n" }, "failureNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStep", "description": "Configuration block for 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 . See `failure_next_step`.\n" }, "failureResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `failure_response`.\n" }, "successConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditional", "description": "Configuration block for conditional branches to evaluate after the dialog code hook finishes successfully. See `success_conditional`.\n" }, "successNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStep", "description": "Configuration block for the next step the bot runs after the dialog code hook finishes successfully. See `success_next_step`.\n" }, "successResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `success_response`.\n" }, "timeoutConditional": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditional", "description": "Configuration block for conditional branches to evaluate if the code hook times out. See `timeout_conditional`.\n" }, "timeoutNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStep", "description": "Configuration block for the next step that the bot runs when the code hook times out. See `timeout_next_step`.\n" }, "timeoutResponse": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond the user input. See `timeout_response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationFailureResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationSuccessResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditional:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranch:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStep:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepDialogAction:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntent:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlot:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlotValue:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponse:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroup:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariation:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingCodeHookPostCodeHookSpecificationTimeoutResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditional:V2modelsIntentConfirmationSettingConfirmationConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranch:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranch:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranch:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranch:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStep:V2modelsIntentConfirmationSettingConfirmationNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntent:V2modelsIntentConfirmationSettingConfirmationNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepDialogAction:V2modelsIntentConfirmationSettingConfirmationNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntent:V2modelsIntentConfirmationSettingConfirmationNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlot:V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlotValue:V2modelsIntentConfirmationSettingConfirmationNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponse:V2modelsIntentConfirmationSettingConfirmationResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroup:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariation:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingConfirmationResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditional:V2modelsIntentConfirmationSettingDeclinationConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranch:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranch:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranch:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranch:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStep:V2modelsIntentConfirmationSettingDeclinationNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntent:V2modelsIntentConfirmationSettingDeclinationNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepDialogAction:V2modelsIntentConfirmationSettingDeclinationNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntent:V2modelsIntentConfirmationSettingDeclinationNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlot:V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlotValue:V2modelsIntentConfirmationSettingDeclinationNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponse:V2modelsIntentConfirmationSettingDeclinationResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroup:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariation:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingDeclinationResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingElicitationCodeHook:V2modelsIntentConfirmationSettingElicitationCodeHook": { "properties": { "enableCodeHookInvocation": { "type": "boolean", "description": "Whether a Lambda function should be invoked for the dialog.\n" }, "invocationLabel": { "type": "string", "description": "Label that indicates the dialog step from which the dialog code hook is happening.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditional:V2modelsIntentConfirmationSettingFailureConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranch:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranch:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranch:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchCondition:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStep:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponse:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranch:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStep:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponse:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureNextStep:V2modelsIntentConfirmationSettingFailureNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureNextStepDialogAction:V2modelsIntentConfirmationSettingFailureNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntent:V2modelsIntentConfirmationSettingFailureNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureNextStepDialogAction:V2modelsIntentConfirmationSettingFailureNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntent:V2modelsIntentConfirmationSettingFailureNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntentSlot:V2modelsIntentConfirmationSettingFailureNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureNextStepIntentSlotValue:V2modelsIntentConfirmationSettingFailureNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponse:V2modelsIntentConfirmationSettingFailureResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroup:V2modelsIntentConfirmationSettingFailureResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroup:V2modelsIntentConfirmationSettingFailureResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariation:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingFailureResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecification:V2modelsIntentConfirmationSettingPromptSpecification": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech prompt from the bot.\n" }, "maxRetries": { "type": "integer", "description": "Maximum number of times the bot tries to elicit a response from the user using this prompt.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroup:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroup" }, "description": "Configuration block for messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime. See `message_group`.\n" }, "messageSelectionStrategy": { "type": "string", "description": "How a message is selected from a message group among retries. Valid values are `Random` and `Ordered`.\n" }, "promptAttemptsSpecifications": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecification" }, "description": "Configuration block for advanced settings on each attempt of the prompt. See `prompt_attempts_specification`.\n" } }, "type": "object", "required": [ "maxRetries" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroup:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariation:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageCustomPayload:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCard:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCardButton:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessagePlainTextMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageSsmlMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariation:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationCustomPayload:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCard:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCardButton:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationPlainTextMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationSsmlMessage:V2modelsIntentConfirmationSettingPromptSpecificationMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecification": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech prompt attempt from the bot.\n" }, "allowedInputTypes": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAllowedInputTypes:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAllowedInputTypes", "description": "Configuration block for the allowed input types of the prompt attempt. See `allowed_input_types`.\n" }, "audioAndDtmfInputSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecification", "description": "Configuration block for settings on audio and DTMF input. See `audio_and_dtmf_input_specification`.\n" }, "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "textInputSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationTextInputSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationTextInputSpecification", "description": "Configuration block for the settings on text input. See `text_input_specification`.\n" } }, "type": "object", "required": [ "allowedInputTypes", "mapBlockKey" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAllowedInputTypes:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAllowedInputTypes": { "properties": { "allowAudioInput": { "type": "boolean", "description": "Whether audio input is allowed.\n" }, "allowDtmfInput": { "type": "boolean", "description": "Whether DTMF input is allowed.\n" } }, "type": "object", "required": [ "allowAudioInput", "allowDtmfInput" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecification": { "properties": { "audioSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationAudioSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationAudioSpecification", "description": "Configuration block for the settings on audio input. See `audio_specification`.\n" }, "dtmfSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationDtmfSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationDtmfSpecification", "description": "Configuration block for the settings on DTMF input. See `dtmf_specification`.\n" }, "startTimeoutMs": { "type": "integer", "description": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.\n" } }, "type": "object", "required": [ "startTimeoutMs" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationAudioSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationAudioSpecification": { "properties": { "endTimeoutMs": { "type": "integer", "description": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished.\n" }, "maxLengthMs": { "type": "integer", "description": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.\n" } }, "type": "object", "required": [ "endTimeoutMs", "maxLengthMs" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationDtmfSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationAudioAndDtmfInputSpecificationDtmfSpecification": { "properties": { "deletionCharacter": { "type": "string", "description": "DTMF character that clears the accumulated DTMF digits and immediately ends the input.\n" }, "endCharacter": { "type": "string", "description": "DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.\n" }, "endTimeoutMs": { "type": "integer", "description": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded.\n" }, "maxLength": { "type": "integer", "description": "Maximum number of DTMF digits allowed in an utterance.\n" } }, "type": "object", "required": [ "deletionCharacter", "endCharacter", "endTimeoutMs", "maxLength" ] }, "aws:lex/V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationTextInputSpecification:V2modelsIntentConfirmationSettingPromptSpecificationPromptAttemptsSpecificationTextInputSpecification": { "properties": { "startTimeoutMs": { "type": "integer", "description": "Time for which a bot waits before re-prompting a customer for text input.\n" } }, "type": "object", "required": [ "startTimeoutMs" ] }, "aws:lex/V2modelsIntentDialogCodeHook:V2modelsIntentDialogCodeHook": { "properties": { "enabled": { "type": "boolean", "description": "Enables the dialog code hook so that it processes user requests.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHook:V2modelsIntentFulfillmentCodeHook": { "properties": { "active": { "type": "boolean", "description": "Whether the fulfillment code hook is used. When active is false, the code hook doesn't run.\n" }, "enabled": { "type": "boolean", "description": "Whether a Lambda function should be invoked to fulfill a specific intent.\n" }, "fulfillmentUpdatesSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecification:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecification", "description": "Configuration block for settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations. See `fulfillment_updates_specification`.\n" }, "postFulfillmentStatusSpecification": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecification:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecification", "description": "Configuration block for 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. See `post_fulfillment_status_specification`.\n" } }, "type": "object", "required": [ "enabled" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecification:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecification": { "properties": { "active": { "type": "boolean", "description": "Whether fulfillment updates are sent to the user. When this field is true, updates are sent. If the active field is set to true, the `start_response`, `update_response`, and `timeout_in_seconds` fields are required.\n" }, "startResponse": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponse:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponse", "description": "Configuration block for the message sent to users when the fulfillment Lambda functions starts running.\n" }, "timeoutInSeconds": { "type": "integer", "description": "Length of time that the fulfillment Lambda function should run before it times out.\n" }, "updateResponse": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponse:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponse", "description": "Configuration block for messages sent periodically to the user while the fulfillment Lambda function is running.\n" } }, "type": "object", "required": [ "active" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponse:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt the start message while it is playing.\n" }, "delayInSeconds": { "type": "integer", "description": "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.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroup:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroup" }, "description": "Between 1-5 configuration block message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroup:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationStartResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponse:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt the start message while it is playing.\n" }, "frequencyInSeconds": { "type": "integer", "description": "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.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroup:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroup" }, "description": "Between 1-5 configuration block message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user. See `message_group`.\n" } }, "type": "object", "required": [ "frequencyInSeconds" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroup:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookFulfillmentUpdatesSpecificationUpdateResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecification:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecification": { "properties": { "failureConditional": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditional:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditional", "description": "Configuration block for 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. See `failure_conditional`.\n" }, "failureNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStep", "description": "Configuration block for 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. See `failure_next_step`.\n" }, "failureResponse": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `failure_response`.\n" }, "successConditional": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditional:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditional", "description": "Configuration block for conditional branches to evaluate after the dialog code hook finishes successfully. See `success_conditional`.\n" }, "successNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessNextStep", "description": "Configuration block for the next step the bot runs after the dialog code hook finishes successfully. See `success_next_step`.\n" }, "successResponse": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessResponse", "description": "Configuration block for message groups that Amazon Lex uses to respond the user input. See `success_response`.\n" }, "timeoutConditional": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutConditional:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutConditional", "description": "Configuration block for conditional branches to evaluate if the code hook times out. See `timeout_conditional`.\n" }, "timeoutNextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutNextStep", "description": "Configuration block for the next step that the bot runs when the code hook times out. See `timeout_next_step`.\n" }, "timeoutResponse": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationTimeoutResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond the user input. See `timeout_response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditional:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchCondition:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchCondition:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationFailureResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditional:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditional": { "properties": { "active": { "type": "boolean", "description": "Whether a conditional branch is active. When active is false, the conditions are not evaluated.\n" }, "conditionalBranches": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranch" }, "description": "Configuration blocks for 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. See `conditional_branch`.\n" }, "defaultBranch": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranch", "description": "Configuration block for the conditional branch that should be followed when the conditions for other branches are not satisfied. A branch is made up of a condition, a response and a next step. See `default_branch`.\n" } }, "type": "object", "required": [ "active", "defaultBranch" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranch": { "properties": { "condition": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchCondition:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchCondition", "description": "Configuration block for the expression to evaluate. If the condition is true, the branch's actions are taken. See `condition`.\n" }, "name": { "type": "string", "description": "Name of the branch.\n" }, "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object", "required": [ "condition", "name", "nextStep" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchCondition:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchCondition": { "properties": { "expressionString": { "type": "string", "description": "Expression string that is evaluated.\n" } }, "type": "object", "required": [ "expressionString" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationPlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalConditionalBranchResponseMessageGroupVariationSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranch:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranch": { "properties": { "nextStep": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStep", "description": "Configuration block for the next step in the conversation. See `next_step`.\n" }, "response": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponse", "description": "Configuration block for a list of message groups that Amazon Lex uses to respond to the user input. See `response`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStep:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStep": { "properties": { "dialogAction": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepDialogAction", "description": "Configuration block for action that the bot executes at runtime when the conversation reaches this step. See `dialog_action`.\n" }, "intent": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntent", "description": "Configuration block for override settings to configure the intent state. See `intent`.\n" }, "sessionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepDialogAction:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepDialogAction": { "properties": { "slotToElicit": { "type": "string", "description": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.\n" }, "suppressNextMessage": { "type": "boolean", "description": "Whether the next message for the intent is _not_ used.\n" }, "type": { "type": "string", "description": "Action that the bot should execute. Valid values are `ElicitIntent`, `StartIntent`, `ElicitSlot`, `EvaluateConditional`, `InvokeDialogCodeHook`, `ConfirmIntent`, `FulfillIntent`, `CloseIntent`, `EndConversation`.\n" } }, "type": "object", "required": [ "type" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntent:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntent": { "properties": { "name": { "type": "string", "description": "Name of the intent.\n" }, "slots": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot" }, "description": "Configuration block for 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. See `slot`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlot": { "properties": { "mapBlockKey": { "type": "string", "description": "Which attempt to configure. Valid values are `Initial`, `Retry1`, `Retry2`, `Retry3`, `Retry4`, `Retry5`.\n" }, "shape": { "type": "string", "description": "When the shape value is `List`, `values` contains a list of slot values. When the value is `Scalar`, `value` contains a single value.\n" }, "value": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue", "description": "Configuration block for the current value of the slot. See `value`.\n" } }, "type": "object", "required": [ "mapBlockKey" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchNextStepIntentSlotValue": { "properties": { "interpretedValue": { "type": "string", "description": "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.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponse:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponse": { "properties": { "allowInterrupt": { "type": "boolean", "description": "Whether the user can interrupt a speech response from Amazon Lex.\n" }, "messageGroups": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroup" }, "description": "Configuration blocks for responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. See `message_group`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroup:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroup": { "properties": { "message": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage", "description": "Configuration block for the primary message that Amazon Lex should send to the user. See `message`.\n" }, "variations": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation" }, "description": "Configuration blocks for message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. See `variation`.\n" } }, "type": "object", "required": [ "message" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessage": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessagePlainTextMessage": { "properties": { "value": { "type": "string", "description": "Message to send to the user.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupMessageSsmlMessage": { "properties": { "value": { "type": "string", "description": "SSML text that defines the prompt.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariation": { "properties": { "customPayload": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload", "description": "Configuration block for a message in a custom format defined by the client application. See `custom_payload`.\n" }, "imageResponseCard": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard", "description": "Configuration block for a message that defines a response card that the client application can show to the user. See `image_response_card`.\n" }, "plainTextMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage", "description": "Configuration block for a message in plain text format. See `plain_text_message`.\n" }, "ssmlMessage": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationSsmlMessage", "description": "Configuration block for a message in Speech Synthesis Markup Language (SSML). See `ssml_message`.\n" } }, "type": "object" }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationCustomPayload": { "properties": { "value": { "type": "string", "description": "String that is sent to your application.\n" } }, "type": "object", "required": [ "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCard": { "properties": { "buttons": { "type": "array", "items": { "$ref": "#/types/aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton" }, "description": "Configuration blocks for buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. See `button`.\n" }, "imageUrl": { "type": "string", "description": "URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.\n" }, "subtitle": { "type": "string", "description": "Subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.\n" }, "title": { "type": "string", "description": "Title to display on the response card. The format of the title is determined by the platform displaying the response card.\n" } }, "type": "object", "required": [ "title" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationImageResponseCardButton": { "properties": { "text": { "type": "string", "description": "Text that appears on the button. Use this to tell the user what value is returned when they choose this button.\n" }, "value": { "type": "string", "description": "Value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.\n" } }, "type": "object", "required": [ "text", "value" ] }, "aws:lex/V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessageGroupVariationPlainTextMessage:V2modelsIntentFulfillmentCodeHookPostFulfillmentStatusSpecificationSuccessConditionalDefaultBranchResponseMessage